Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

css::minifier::xs(3pm) [debian man page]

CSS::Minifier::XS(3pm)					User Contributed Perl Documentation				    CSS::Minifier::XS(3pm)

NAME

       CSS::Minifier::XS - XS based CSS minifier

SYNOPSIS

	 use CSS::Minifier::XS qw(minify);
	 $minified = minify($css);

DESCRIPTION

       "CSS::Minifier::XS" is a CSS "minifier"; its designed to remove un-necessary whitespace and comments from CSS files, while also not
       breaking the CSS.

       "CSS::Minifier::XS" is similar in function to "CSS::Minifier", but is substantially faster as its written in XS and not just pure Perl.

METHODS

       minify($css)
	   Minifies the given $css, returning the minified CSS back to the caller.

HOW IT WORKS

       "CSS::Minifier::XS" minifies the CSS by removing un-necessary whitespace from CSS documents.  Comment blocks are also removed, except when
       (a) they contain the word "copyright" in them, or (b) they're needed to implement the "Mac/IE Comment Hack".

       Internally, the minification is done by taking multiple passes through the CSS document:

   Pass 1: Tokenize
       First, we go through and parse the CSS document into a series of tokens internally.  The tokenizing process does not check to make sure
       that you've got syntactically valid CSS, it just breaks up the text into a stream of tokens suitable for processing by the subsequent
       stages.

   Pass 2: Collapse
       We then march through the token list and collapse certain tokens down to their smallest possible representation.  If they're still included
       in the final results we only want to include them at their shortest.

       Whitespace
	   Runs of multiple whitespace characters are reduced down to a single whitespace character.  If the whitespace contains any "end of line"
	   (EOL) characters, then the end result is the first EOL character encountered.  Otherwise, the result is the first whitespace character
	   in the run.

       Comments
	   Comments implementing the "Mac/IE Comment Hack" are collapsed down to the smallest possible comment that would still implement the hack
	   ("/**/" to start the hack, and "/**/" to end it).

   Pass 3: Pruning
       We then go back through the token list and prune and remove un-necessary tokens.

       Whitespace
	   Wherever possible, whitespace is removed; before+after comment blocks, and before+after various symbols/sigils.

       Comments
	   Comments that either (a) are needed to implement the "Mac/IE Comment Hack", or that (b) contain the word "copyright" in them are
	   preserved.  All other comments are removed.

       Symbols/Sigils
	   Semi-colons that are immediately followed by a closing brace (e.g. ";}") are removed; semi-colons are needed to separate multiple
	   declarations, but aren't required at the end of a group.

       Everything else
	   We keep everything else; identifiers, quoted literal strings, symbols/sigils, etc.

   Pass 4: Re-assembly
       Lastly, we go back through the token list and re-assemble it all back into a single CSS string, which is then returned back to the caller.

AUTHOR

       Graham TerMarsch (cpan@howlingfrog.com)

REPORTING BUGS

       Please report bugs via RT (<http://rt.cpan.org/Dist/Display.html?Queue=CSS::Minifier::XS>), and be sure to include the CSS that you're
       having troubles minifying.

COPYRIGHT

       Copyright (C) 2007-2010, Graham TerMarsch.  All Rights Reserved.

       This is free software; you can redistribute it and/or modify it under the same license as Perl itself.

SEE ALSO

       "CSS::Minifier".

perl v5.14.2							    2011-11-15						    CSS::Minifier::XS(3pm)

Check Out this Related Man Page

JavaScript::Minifier(3pm)				User Contributed Perl Documentation				 JavaScript::Minifier(3pm)

NAME

       JavaScript::Minifier - Perl extension for minifying JavaScript code

SYNOPSIS

       To minify a JavaScript file and have the output written directly to another file

	 use JavaScript::Minifier qw(minify);
	 open(INFILE, 'myScript.js') or die;
	 open(OUTFILE, '>myScript-min.js') or die;
	 minify(input => *INFILE, outfile => *OUTFILE);
	 close(INFILE);
	 close(OUTFILE);

       To minify a JavaScript string literal. Note that by omitting the outfile parameter a the minified code is returned as a string.

	 my minifiedJavaScript = minify(input => 'var x = 2;');

       To include a copyright comment at the top of the minified code.

	 minify(input => 'var x = 2;', copyright => 'BSD License');

       To treat ';;;' as '//' so that debugging code can be removed. This is a common JavaScript convention for minification.

	 minify(input => 'var x = 2;', stripDebug => 1);

       The "input" parameter is manditory. The "output", "copyright", and "stripDebug" parameters are optional and can be used in any combination.

DESCRIPTION

       This module removes unnecessary whitespace from JavaScript code. The primary requirement developing this module is to not break working
       code: if working JavaScript is in input then working JavaScript is output. It is ok if the input has missing semi-colons, snips like '++ +'
       or '12 .toString()', for example. Internet Explorer conditional comments are copied to the output but the code inside these comments will
       not be minified.

       The ECMAScript specifications allow for many different whitespace characters: space, horizontal tab, vertical tab, new line, carriage
       return, form feed, and paragraph separator. This module understands all of these as whitespace except for vertical tab and paragraph
       separator. These two types of whitespace are not minimized.

       For static JavaScript files, it is recommended that you minify during the build stage of web deployment. If you minify on-the-fly then it
       might be a good idea to cache the minified file. Minifying static files on-the-fly repeatedly is wasteful.

   EXPORT
       None by default.

       Exportable on demand: minifiy()

SEE ALSO

       This project is developed using an SVN repository. To check out the repository svn co http://dev.michaux.ca/svn/random/JavaScript-Minifier

       This module is inspired by Douglas Crockford's JSMin: http://www.crockford.com/javascript/jsmin.html

       You may also be interested in the CSS::Minifier module also available on CPAN.

AUTHORS

       Peter Michaux, <petermichaux@gmail.com> Eric Herrera, <herrera@10east.com>

COPYRIGHT AND LICENSE

       Copyright (C) 2007 by Peter Michaux

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.6 or,
       at your option, any later version of Perl 5 you may have available.

perl v5.10.1							    2010-12-19						 JavaScript::Minifier(3pm)
Man Page