.\" -*- 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::Packer 3pm"
.TH JavaScript::Packer 3pm 2024-03-05 "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::Packer \- Perl version of Dean Edwards' Packer.js
.SH VERSION
.IX Header "VERSION"
Version 2.10
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A JavaScript Compressor
.PP
This module is an adaptation of Dean Edwards' Packer.js.
.PP
Additional information: http://dean.edwards.name/packer/
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use JavaScript::Packer;
\&
\&    my $packer = JavaScript::Packer\->init();
\&
\&    $packer\->minify( $javascript, $opts );
.Ve
.PP
To return a scalar without changing the input simply use (e.g. example 2):
.PP
.Vb 1
\&    my $ret = $packer\->minify( $javascript, $opts );
.Ve
.PP
For backward compatibility it is still possible to call 'minify' as a function:
.PP
.Vb 1
\&    JavaScript::Packer::minify( $javascript, $opts );
.Ve
.PP
The first argument must be a scalarref of javascript-code.
.PP
Second argument must be a hashref of options. Possible options are:
.IP compress 4
.IX Item "compress"
Defines compression level. Possible values are 'clean', 'shrink', 'obfuscate'
and 'best'.
Default value is 'clean'.
\&'best' uses 'shrink' or 'obfuscate' depending on which result is shorter. This
is recommended because especially when compressing short scripts the result
will exceed the input if compression level is 'obfuscate'.
.IP copyright 4
.IX Item "copyright"
You can add a copyright notice at the top of the script.
.IP remove_copyright 4
.IX Item "remove_copyright"
If there is a copyright notice in a comment it will only be removed if this
option is set to a true value. Otherwise the first comment that contains the
word "copyright" will be added at the top of the packed script. A copyright
comment will be overwritten by a copyright notice defined with the copyright
option.
.IP no_compress_comment 4
.IX Item "no_compress_comment"
If not set to a true value it is allowed to set a JavaScript comment that
prevents the input being packed or defines a compression level.
.Sp
.Vb 2
\&    /* JavaScript::Packer _no_compress_ */
\&    /* JavaScript::Packer shrink */
.Ve
.SH EXAMPLES
.IX Header "EXAMPLES"
.IP "Example 1" 4
.IX Item "Example 1"
Common usage.
.Sp
.Vb 1
\&    #!/usr/bin/perl
\&
\&    use strict;
\&    use warnings;
\&
\&    use JavaScript::Packer;
\&
\&    my $packer = JavaScript::Packer\->init();
\&
\&    open( UNCOMPRESSED, \*(Aquncompressed.js\*(Aq );
\&    open( COMPRESSED, \*(Aq>compressed.js\*(Aq );
\&
\&    my $js = join( \*(Aq\*(Aq, <UNCOMPRESSED> );
\&
\&    $packer\->minify( \e$js, { compress => \*(Aqbest\*(Aq } );
\&
\&    print COMPRESSED $js;
\&    close(UNCOMPRESSED);
\&    close(COMPRESSED);
.Ve
.IP "Example 2" 4
.IX Item "Example 2"
A scalar is requested by the context. The input will remain unchanged.
.Sp
.Vb 1
\&    #!/usr/bin/perl
\&
\&    use strict;
\&    use warnings;
\&
\&    use JavaScript::Packer;
\&
\&    my $packer = JavaScript::Packer\->init();
\&
\&    open( UNCOMPRESSED, \*(Aquncompressed.js\*(Aq );
\&    open( COMPRESSED, \*(Aq>compressed.js\*(Aq );
\&
\&    my $uncompressed = join( \*(Aq\*(Aq, <UNCOMPRESSED> );
\&
\&    my $compressed = $packer\->minify( \e$uncompressed, { compress => \*(Aqbest\*(Aq } );
\&
\&    print COMPRESSED $compressed;
\&    close(UNCOMPRESSED);
\&    close(COMPRESSED);
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
Merten Falk, \f(CW\*(C`<nevesenin at cpan.org>\*(C'\fR. Now maintained by Lee
Johnson (LEEJO)
.SH "BUGS AND CAVEATS"
.IX Header "BUGS AND CAVEATS"
This module will break code that relies on ASI, see <https://github.com/leejo/javascript\-packer\-perl/issues/5>
for more information.
.PP
This module uses regular expressions to parse the JavaScript so is prone
to bugs and edge cases, especially when the JavaScript standard is updated
.PP
Please report any bugs or feature requests through the web interface at
<http://github.com/leejo/javascript\-packer\-perl/issues>.
.SH SUPPORT
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
perldoc JavaScript::Packer
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2008 \- 2012 Merten Falk, all rights reserved.
.PP
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.