From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

LEEJO / JavaScript-Packer-2.11 / README 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

              
NAME
    JavaScript::Packer - Perl version of Dean Edwards' Packer.js
VERSION
    Version 2.04
DESCRIPTION
    A JavaScript Compressor
    This module is an adaptation of Dean Edwards' Packer.js.
    Additional information: http://dean.edwards.name/packer/
SYNOPSIS
        use JavaScript::Packer;
        my $packer = JavaScript::Packer->init();
        $packer->minify( $javascript, $opts );
    To return a scalar without changing the input simply use (e.g. example
    2):
        my $ret = $packer->minify( $javascript, $opts );
    For backward compatibility it is still possible to call 'minify' as a
    function:
        JavaScript::Packer::minify( $javascript, $opts );
    The first argument must be a scalarref of javascript-code.
    Second argument must be a hashref of options. Possible options are:
    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'.
    copyright
        You can add a copyright notice at the top of the script.
    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.
    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.
            /* JavaScript::Packer _no_compress_ */
            /* JavaScript::Packer shrink */
EXAMPLES
    Example 1
        Common usage.
            #!/usr/bin/perl
            use strict;
            use warnings;
            use JavaScript::Packer;
            my $packer = JavaScript::Packer->init();
            open( UNCOMPRESSED, 'uncompressed.js' );
            open( COMPRESSED, '>compressed.js' );
            my $js = join( '', <UNCOMPRESSED> );
            $packer->minify( \$js, { compress => 'best' } );
            print COMPRESSED $js;
            close(UNCOMPRESSED);
            close(COMPRESSED);
    Example 2
        A scalar is requested by the context. The input will remain
        unchanged.
            #!/usr/bin/perl
            use strict;
            use warnings;
            use JavaScript::Packer;
            my $packer = JavaScript::Packer->init();
            open( UNCOMPRESSED, 'uncompressed.js' );
            open( COMPRESSED, '>compressed.js' );
            my $uncompressed = join( '', <UNCOMPRESSED> );
            my $compressed = $packer->minify( \$uncompressed, { compress => 'best' } );
            print COMPRESSED $compressed;
            close(UNCOMPRESSED);
            close(COMPRESSED);
AUTHOR
    Merten Falk, `<nevesenin at cpan.org>'. Now maintained by Lee Johnson
    (LEEJO)
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.
    Please report any bugs or feature requests through the web interface at
    http://github.com/leejo/javascript-packer-perl/issues.
SUPPORT
    You can find documentation for this module with the perldoc command.
    perldoc JavaScript::Packer
COPYRIGHT & LICENSE
    Copyright 2008 - 2012 Merten Falk, all rights reserved.
    This program is free software; you can redistribute it and/or modify it
    under the same terms as Perl itself.