Skip to content
Browse files

Tag the v0.1.0 release

  • Loading branch information...
0 parents commit 256469b528dd77c404b3764af17782732129e281 @mathiasbynens committed Jun 3, 2012
Showing with 549 additions and 0 deletions.
  1. +2 −0 .gitattributes
  2. +14 −0 .gitignore
  3. +1 −0 .npmignore
  4. +278 −0 LICENSE-GPL.txt
  5. +20 −0 LICENSE-MIT.txt
  6. +72 −0 README.md
  7. +2 −0 bin/grunt-yui-compressor
  8. +9 −0 examples/example.css
  9. +7 −0 examples/example.js
  10. +1 −0 examples/example.min.css
  11. +4 −0 examples/example.min.js
  12. +46 −0 grunt.js
  13. +42 −0 package.json
  14. +51 −0 tasks/yui-compressor.js
2 .gitattributes
@@ -0,0 +1,2 @@
+# Automatically normalize line endings for all text-based files
+* text=auto
14 .gitignore
@@ -0,0 +1,14 @@
+# Node modules
+node_modules
+
+# Folder view configuration files
+.DS_Store
+Desktop.ini
+
+# Thumbnail cache files
+._*
+Thumbs.db
+
+# Files that might appear on external disks
+.Spotlight-V100
+.Trashes
1 .npmignore
@@ -0,0 +1 @@
+/node_modules/
278 LICENSE-GPL.txt
@@ -0,0 +1,278 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
20 LICENSE-MIT.txt
@@ -0,0 +1,20 @@
+Copyright Mathias Bynens <http://mathiasbynens.be/>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
72 README.md
@@ -0,0 +1,72 @@
+# grunt-yui-compressor
+
+A [grunt](https://github.com/cowboy/grunt) plugin for compressing JavaScript and CSS files using YUI Compressor.
+
+## Getting Started
+
+Install the module:
+
+```bash
+npm install grunt-yui-compressor
+```
+
+Then add this line to your project’s `grunt.js` gruntfile:
+
+```js
+grunt.loadNpmTasks('grunt-yui-compressor');
+```
+
+Now you can specify CSS/JS files to minify. Here’s a basic example:
+
+```js
+'min': {
+ 'dist': {
+ 'src': ['src/foo.js', 'src/bar.js'],
+ 'dest': 'build/foobar.min.js'
+ }
+},
+'cssmin': {
+ 'dist': {
+ 'src': ['css/foo.css', 'css/bar.css'],
+ 'dest': 'build/foobar.min.css'
+ }
+}
+```
+
+Both `min` and `cssmin` use the same API as [the built-in `min` task](https://github.com/cowboy/grunt/blob/master/docs/task_min.md#usage-examples).
+
+## Documentation
+
+This plugin does two things:
+
+* It overrides grunt’s built-in `min` task, and makes it use YUI Compressor instead of UglifyJS.
+* It provides a `cssmin` task that uses YUI Compressor to compress CSS files.
+
+Both these tasks are [multi tasks](https://github.com/cowboy/grunt/blob/master/docs/types_of_tasks.md#multi-tasks), meaning that each of them will implicitly iterate over all of its targets if no target is specified.
+
+## FAQ
+
+### Why not just use grunt’s built-in `min` task to minify JavaScript?
+
+Grunt’s built-in `min` task relies on UglifyJS. I love UglifyJS, but it has a few annoying issues and shortcomings:
+
+* It strips license comments of the form `/*! foo */`, only preserving the first comment in the concatenated file. This may cause you to violate licenses of open-source libraries that you’re using in your projects.
+* It doesn’t [escape](http://mathiasbynens.be/notes/javascript-escapes) non-printable ASCII characters in the output, potentially leading to hard-to-debug issues. Try minifying `\x0b`, for example.
+* There’s no way to make UglifyJS not munge a variable name.
+
+YUI Compressor doesn’t have these issues.
+
+## Contributing
+
+Feel free to fork if you see possible improvements!
+
+In lieu of a formal style guide, take care to maintain the existing coding style. Please lint your code (by simply running `grunt`) before submitting a patch.
+
+## Authors
+
+* [Mathias Bynens](http://mathiasbynens.be/)
+ [![@mathias on Twitter](http://gravatar.com/avatar/24e08a9ea84deb17ae121074d0f17125?s=70)](http://twitter.com/mathias "Follow @mathias on Twitter")
+
+## License
+
+This project is dual licensed under the [MIT](http://mths.be/mit) and [GPL](http://mths.be/gpl) licenses.
2 bin/grunt-yui-compressor
@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('grunt').npmTasks('grunt-yui-compressor').cli();
9 examples/example.css
@@ -0,0 +1,9 @@
+html {
+ background: hotpink;
+}
+
+@media (max-width: 40em) {
+ html {
+ border: 1px solid lime;
+ }
+}
7 examples/example.js
@@ -0,0 +1,7 @@
+/*! License comment */
+(function() {
+ "foo:nomunge";
+ /*! Weird inline license comment */
+ var foo = 42,
+ bar = 'lol\x0bwat';
+}());
1 examples/example.min.css
@@ -0,0 +1 @@
+html{background:hotpink}@media(max-width:40em){html{border:1px solid lime}}
4 examples/example.min.js
@@ -0,0 +1,4 @@
+/*! License comment */
+(function(){
+/*! Weird inline license comment */
+var foo=42,a="lol\x0bwat"}());
46 grunt.js
@@ -0,0 +1,46 @@
+module.exports = function(grunt) {
+
+ grunt.initConfig({
+ 'min': {
+ 'dist': {
+ 'src': 'examples/example.js',
+ 'dest': 'examples/example.min.js'
+ }
+ },
+ 'cssmin': {
+ 'dist': {
+ 'src': 'examples/example.css',
+ 'dest': 'examples/example.min.css'
+ }
+ },
+ 'lint': {
+ 'files': ['grunt.js', 'tasks/yui-compressor.js']
+ },
+ 'watch': {
+ 'files': '<config:lint.files>',
+ 'tasks': 'default'
+ },
+ 'jshint': {
+ 'options': {
+ 'curly': true,
+ 'immed': true,
+ 'latedef': true,
+ 'newcap': true,
+ 'noarg': true,
+ 'undef': true,
+ 'boss': true,
+ 'eqnull': true,
+ 'node': true,
+ 'es5': true,
+ 'trailing': true,
+ 'smarttabs': true
+ },
+ 'globals': {}
+ }
+ });
+
+ grunt.loadTasks('tasks');
+
+ grunt.registerTask('default', 'lint min cssmin');
+
+};
42 package.json
@@ -0,0 +1,42 @@
+{
+ "name": "grunt-yui-compressor",
+ "description": "A grunt plugin for compressing JavaScript and CSS files using YUI Compressor.",
+ "version": "0.1.0",
+ "homepage": "https://github.com/mathiasbynens/grunt-yui-compressor",
+ "author": {
+ "name": "Mathias Bynens",
+ "email": "mathias@qiwi.be",
+ "url": "http://mathiasbynens.be/"
+ },
+ "repository": {
+ "type": "git",
+ "url": "git://github.com/mathiasbynens/grunt-yui-compressor.git"
+ },
+ "bugs": {
+ "url": "https://github.com/mathiasbynens/grunt-yui-compressor/issues"
+ },
+ "licenses": [
+ {
+ "type": "MIT",
+ "url": "https://github.com/mathiasbynens/grunt-yui-compressor/blob/master/LICENSE-MIT"
+ }
+ ],
+ "main": "grunt.js",
+ "bin": "bin/grunt-yui-compressor",
+ "engines": {
+ "node": "*"
+ },
+ "scripts": {
+ "test": "grunt test"
+ },
+ "dependencies": {
+ "grunt": "~0.3.8",
+ "node-minify": "~0.3.10"
+ },
+ "devDependencies": {
+ "grunt": "~0.3.8"
+ },
+ "keywords": [
+ "gruntplugin"
+ ]
+}
51 tasks/yui-compressor.js
@@ -0,0 +1,51 @@
+module.exports = function(grunt) {
+
+ var Compressor = require('node-minify').minify;
+
+ grunt.registerHelper('yui-compressor', function(options) {
+ var source = options.source,
+ destination = options.destination,
+ max = grunt.helper('concat', source),
+ min;
+ new Compressor({
+ 'type': 'yui-' + options.type,
+ 'fileIn': source,
+ 'fileOut': destination,
+ 'callback': function(error) {
+ if (error) {
+ grunt.warn(error);
+ return options.fn();
+ }
+ min = grunt.file.read(destination);
+ grunt.log.writeln('File `' + destination + '` created.');
+ grunt.helper('min_max_info', min, max);
+ // Let grunt know the asynchronous task has completed
+ options.fn();
+ }
+ });
+ });
+
+ grunt.registerMultiTask('min', 'Minify JavaScript files with YUI Compressor.', function() {
+ var done = this.async(),
+ source = grunt.file.expandFiles(this.file.src),
+ destination = this.file.dest;
+ grunt.helper('yui-compressor', {
+ 'type': 'js',
+ 'source': source,
+ 'destination': destination,
+ 'fn': this.async()
+ });
+ });
+
+ grunt.registerMultiTask('cssmin', 'Minify CSS files with YUI Compressor.', function() {
+ var source = grunt.file.expandFiles(this.file.src),
+ destination = this.file.dest;
+ grunt.helper('yui-compressor', {
+ 'type': 'css',
+ 'source': source,
+ 'destination': destination,
+ 'fn': this.async()
+ });
+ });
+
+};

0 comments on commit 256469b

Please sign in to comment.
Something went wrong with that request. Please try again.