.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "JavaScript::Minifier::XS 3pm"
.TH JavaScript::Minifier::XS 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
JavaScript::Minifier::XS \- XS based JavaScript minifier
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\&  use JavaScript::Minifier::XS qw(minify);
\&  my $js       = \*(Aq...\*(Aq;
\&  my $minified = minify($js);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`JavaScript::Minifier::XS\*(C'\fR is a JavaScript "minifier"; its designed to remove
unnecessary whitespace and comments from JavaScript files, which also \fBnot\fR
breaking the JavaScript.
.PP
\&\f(CW\*(C`JavaScript::Minifier::XS\*(C'\fR is similar in function to \f(CW\*(C`JavaScript::Minifier\*(C'\fR,
but is substantially faster as its written in XS and not just pure Perl.
.SH METHODS
.IX Header "METHODS"
.IP minify($js) 4
.IX Item "minify($js)"
Minifies the given \f(CW$js\fR, returning the minified JavaScript back to the
caller.
.SH "HOW IT WORKS"
.IX Header "HOW IT WORKS"
\&\f(CW\*(C`JavaScript::Minifier::XS\*(C'\fR minifies the JavaScript by removing unnecessary
whitespace from JavaScript documents.  Comments (both block and line) are also
removed, \fIexcept\fR when (a) they contain the word "copyright" in them, or (b)
they're needed to implement "IE Conditional Compilation".
.PP
Internally, the minification process is done by taking multiple passes through
the JavaScript document:
.SS "Pass 1: Tokenize"
.IX Subsection "Pass 1: Tokenize"
First, we go through and parse the JavaScript document into a series of tokens
internally.  The tokenizing process \fBdoes not\fR 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.
.SS "Pass 2: Collapse"
.IX Subsection "Pass 2: Collapse"
We then march through the token list and collapse certain tokens down to their
smallest possible representation.  \fIIf\fR they're still included in the final
results we only want to include them at their shortest.
.IP Whitespace 4
.IX Item "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 \fIfirst\fR EOL character encountered.  Otherwise, the
result is the first whitespace character in the run.
.SS "Pass 3: Pruning"
.IX Subsection "Pass 3: Pruning"
We then go back through the token list and prune and remove unnecessary
tokens.
.IP Whitespace 4
.IX Item "Whitespace"
Wherever possible, whitespace is removed; before+after comment blocks, and
before+after various symbols/sigils.
.IP Comments 4
.IX Item "Comments"
Comments that are either (a) IE conditional compilation comments, or that (b)
contain the word "copyright" in them are preserved.  \fBAll\fR other comments
(line and block) are removed.
.IP "Everything else" 4
.IX Item "Everything else"
We keep everything else; identifiers, quoted literal strings, symbols/sigils,
etc.
.SS "Pass 4: Re-assembly"
.IX Subsection "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.
.SH AUTHOR
.IX Header "AUTHOR"
Graham TerMarsch (cpan@howlingfrog.com)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2007\-, Graham TerMarsch.  All Rights Reserved.
.PP
This is free software; you can redistribute it and/or modify it under the same
license as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\f(CW\*(C`JavaScript::Minifier\*(C'\fR.