javascript::minifier::xs(3pm) [debian man page]
JavaScript::Minifier::XS(3pm) User Contributed Perl Documentation JavaScript::Minifier::XS(3pm) NAME
JavaScript::Minifier::XS - XS based JavaScript minifier SYNOPSIS
use JavaScript::Minifier::XS qw(minify); $minified = minify($js); DESCRIPTION
"JavaScript::Minifier::XS" is a JavaScript "minifier"; its designed to remove un-necessary whitespace and comments from JavaScript files, which also not breaking the JavaScript. "JavaScript::Minifier::XS" is similar in function to "JavaScript::Minifier", but is substantially faster as its written in XS and not just pure Perl. METHODS
minify($js) Minifies the given $js, returning the minified JavaScript back to the caller. HOW IT WORKS
"JavaScript::Minifier::XS" minifies the JavaScript by removing un-necessary whitespace from JavaScript documents. Comments (both block and line) are also removed, except when (a) they contain the word "copyright" in them, or (b) they're needed to implement "IE Conditional Compilation". Internally, the minification process is done by taking multiple passes through the JavaScript document: Pass 1: Tokenize First, we go through and parse the JavaScript document into a series of tokens internally. The tokenizing process does not check to make sure you've got syntactically valid JavaScript, 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. 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 are either (a) IE conditional compilation comments, or that (b) contain the word "copyright" in them are preserved. All other comments (line and block) are removed. 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 JavaScript 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=JavaScript::Minifier::XS>), and be sure to include the JavaScript that you're having troubles minifying. COPYRIGHT
Copyright (C) 2007-2008, 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
"JavaScript::Minifier". perl v5.14.2 2011-11-15 JavaScript::Minifier::XS(3pm)
Check Out this Related Man Page
JavaScript(3pm) User Contributed Perl Documentation JavaScript(3pm) NAME
Data::JavaScript - Dump perl data structures into JavaScript code SYNOPSIS
use Data::JavaScript; # Use defaults @code = jsdump('my_array', $array_ref); # Return array for formatting $code = jsdump('my_object', $hash_ref); # Return convenient string $html = hjsdump('my_stuff', $reference); # Convenience wrapper DESCRIPTION
This module is mainly intended for CGI programming, when a perl script generates a page with client side JavaScript code that needs access to structures created on the server. It works by creating one line of JavaScript code per datum. Therefore, structures cannot be created anonymously and need to be assigned to variables. However, this format enables dumping large structures. The module can output code for different versions of JavaScript. It currently supports 1.1, 1.3 and you specify the version on the "use" line like so: use Data::JavaScript {JS=>1.3}; # The new default use Data::JavaScript {JS=>1.1}; # Old (pre module v1.10) format JavaScript 1.3 contains support for UTF-8 and a native "undefined" datatype. Earlier versions support neither, and will default to an empty string '' for undefined values. You may define your own default--for either version--at compile time by supplying the default value on the "use" line: use Data::JavaScript {JS=>1.1, UNDEF=>'null'}; Other useful values might be 0, "null", or "NaN". EXPORT
In addition, althought the module no longer uses Exporter, it heeds its import conventions; "qw(:all"), "()", etc. jsdump('name', $reference, [$undef]); The first argument is required, the name of JavaScript object to create. The second argument is required, a hashref or arrayref. Structures can be nested, circular referrencing is supported (experimentally). The third argument is optional, a scalar whose value is to be used en lieu of undefined values when dumping a structure. When called in list context, the function returns a list of lines. In scalar context, it returns a string. hjsdump('name', $reference, [$undef]); hjsdump is identical to jsdump except that it wraps the content in script tags. EXPORTABLE
__quotemeta($str) This function escapes non-printable and Unicode characters (where possible) to promote playing nice with others. CAVEATS
Previously, the module eval'd any data it received that looked like a number; read: real, hexadecimal, octal, or engineering notations. It now passes all non-decimal values through as strings. You will need to "eval" on the client or server side if you wish to use other notations as numbers. This is meant to protect people who store ZIP codes with leading 0's. Unicode support requires perl 5.8 or later. Older perls will gleefully escape the non-printable portions of any UTF-8 they are fed, likely munging it in the process as far as JavaScript is concerned. If this turns out to be a problem and there is sufficient interest it may be possible to hack-in UTF-8 escaping for older perls. LICENSE
o Thou shalt not claim ownership of unmodified materials. o Thou shalt not claim whole ownership of modified materials. o Thou shalt grant the indemnity of the provider of materials. o Thou shalt use and dispense freely without other restrictions. Or if you truly insist, you may use and distribute this under ther terms of Perl itself (GPL and/or Artistic License). SEE ALSO
Data::JavaScript::LiteObject, Data::JavaScript::Anon, CGI::AJAX AUTHOR
Maintained by Jerrad Pierce <jpierce@cpan.org> Created by Ariel Brosh <schop cpan.org>. Inspired by WDDX.pm JavaScript support. perl v5.10.0 2008-08-14 JavaScript(3pm)