#!perl

our $DATE = '2015-04-15'; # DATE
our $VERSION = '0.37'; # VERSION

use 5.010001;
use strict;
use warnings;

use Perinci::CmdLine::fatten;

Perinci::CmdLine::fatten->new(
    log => 1,
    url => '/App/fatten/fatten',
)->run;

# ABSTRACT: Pack your dependencies onto your script file
# PODNAME: fatten

__END__

=pod

=encoding UTF-8

=head1 NAME

fatten - Pack your dependencies onto your script file

=head1 VERSION

This document describes version 0.37 of fatten (from Perl distribution App-fatten), released on 2015-04-15.

=head1 SYNOPSIS

Basic usage (input & output):

 # by default outputs to '<script>.fatpack' in the source directory, or in
 # current directory if source directory is not writable.
 % fatten bin/script.pl

 # specify output path
 % fatten bin/script.pl -o /tmp/script.pl

 # output to stdout
 % fatten bin/script.pl -o -

 # input from stdin (output will default to stdout, unless you give -o)
 % download-perl-script | fatten

 # see debug messages (what modules are being traced and included, etc)
 % fatten --debug <script.pl >script.fatpack

Including and excluding modules:

 # add some more modules not detected by the tracer
 % fatten -I Foo::Bar -I Foo::Baz bin/script.pl -o script.fatpack

 # change trace method, usually 'require' will give pretty complete result
 % fatten -t require <script.pl >script.fatpack

 # don't trace modules from script, but include all modules found under 'fatlib'
 % fatten -t none --include-from-dir fatlib bin/script.pl -o script.fatpack

See more options:

 % fatten --help

=head1 DESCRIPTION

 "Thank you for a freakin awesome app. Seriously, fatten is great! <3"
 -- Paul J. Fenwick

B<fatten> is an alternative command-line script for L<App::FatPacker>. I had a
few problems when using the B<fatpack> script which comes with
C<App::FatPacker>, namely: 1) using B<fatpack> to produce a fatpacked-script is
a multistep process and I always forget the steps; 2) some modules that ought to
be included are often not included; 3) I can't exclude some modules that I don't
want to include, e.g. Perl core modules which should always already be
available.

Thus, here are the differences of B<fatten> compared to B<fatpack>:

=over

=item * A simpler interface and some nice defaults

Using B<fatten>, you only need a single step to produce the final result.

Currently B<fatten> ignores C<fatlib/> and XS modules. It only focuses on
creating free-standing Perl script which depends on pure-Perl modules (C<.pm>
files) only. Including C<fatlib/> to a stand-alone script will require an
approach like L<PAR::Archive> (i.e. bundling the required files in an archive
and extracting the required files into a temporary directory).

By default B<fatten> skips Perl core modules. This results in a smaller product.

B<fatpack> sometimes fails to include some modules because it can't find the
C<.packlist> for said modules. B<fatten> goes ahead and tries the next best
thing which is to copy just the C<.pm> files.

=item * Alternative methods to trace script's dependencies

There are various methods of tracing a script's dependencies, each with their
own pro's and con's. B<fatpack> checks C<%INC> in the C<CHECK> phase, and this
misses modules loaded during run-time using C<require>. Other methods include:
trapping C<require> (but this can also miss modules loaded conditionally
depending on execution path), static analysis using L<Perl::PrereqScanner> (this
can also miss some modules loaded in unusual ways).

B<fatten> uses L<App::tracepm>, which provides various methods of tracing. See
App::tracepm documentation for more details.

Of course, like B<fatpack>, you can also specify additional modules to include.
And, unlike B<fatpack>, you can specify modules to exclude as well.

=item * Some extra options

Like an option to strip/squish the module source codes with L<Perl::Strip>
(C<--strip>) or L<Perl::Stripper> (C<--stripper>) or L<Perl::Squish>
(C<--squish>).

=item * Configuration file support

See L</"CONFIGURATION FILE"> for more details.

=back

=head1 OPTIONS

C<*> marks required options.

=head2 Configuration options

=over

=item B<--config-path>=I<filename>

Set path to configuration file.

Can be specified multiple times.

=item B<--config-profile>=I<s>

Set configuration profile to use.

=item B<--no-config>

Do not use any configuration file.

=back

=head2 Debugging options

=over

=item B<--debug-keep-tempdir>

Keep temporary directory for debugging.

=back

=head2 Environment options

=over

=item B<--no-env>

Do not read environment for default options.

=back

=head2 Logging options

=over

=item B<--debug>

Set log level to debug.

=item B<--log-level>=I<s>

Set log level.

=item B<--quiet>

Set log level to quiet.

=item B<--trace>

Set log level to trace.

=item B<--verbose>

Set log level to info.

=back

=head2 Module selection options

=over

=item B<--exclude-dist-json>=I<distname>

Exclude all modules of dist (JSON-encoded).

See C<--exclude-dist>.

=item B<--exclude-dist>=I<distname>

Exclude all modules of dist.

Just like the `exclude` option, but will exclude module as well as other modules
from the same distribution. Module name must be the main module of the
distribution. Will determine other modules from the `.packlist` file.


Can be specified multiple times.

=item B<--exclude-json>=I<modulename>, B<-E>

Modules to exclude (JSON-encoded).

See C<--exclude>.

=item B<--exclude-list>=I<filename>

Exclude modules from a list in a file.

=item B<--exclude-pattern-json>=I<s>, B<-p>

Regex patterns of modules to exclude (JSON-encoded).

See C<--exclude-pattern>.

=item B<--exclude-pattern>=I<s@>

Regex pattern of modules to exclude.

When you don't want to include a pattern of modules, specify it here.


Can be specified multiple times.

=item B<--exclude-prereq-json>=I<s>

See C<--exclude-prereq>.

=item B<--exclude-prereq>=I<s@>

Allow script to depend on a module instead of fatpacking it.

This option can be used to express that script will depend on a specified
module, instead of including it fatpacked. The prereq-ed module, as well as
other modules in the same distribution, as well as its prereqs and so on
recursively, will be excluded from fatpacking as well.

This option can be used to express dependency to an XS module, since XS modules
cannot be fatpacked.

To query dependencies, a local CPAN index is used for querying speed. Thus, this
option requires that `lcpan` is installed and a fairly recent lcpan index is
available.


Can be specified multiple times.

=item B<--exclude>=I<modulename>

Exclude a module.

When you don't want to include a module, specify it here.


Can be specified multiple times.

=item B<--include-dir-json>=I<dirname>

Include extra modules under directories (JSON-encoded).

See C<--include-dir>.

=item B<--include-dir>=I<dirname>

Include extra modules under a directory.

Can be specified multiple times.

=item B<--include-dist-json>=I<distname>

Include all modules of dist (JSON-encoded).

See C<--include-dist>.

=item B<--include-dist>=I<distname>

Include all modules of dist.

Just like the `include` option, but will include module as well as other modules
from the same distribution. Module name must be the main module of the
distribution. Will determine other modules from the `.packlist` file.


Can be specified multiple times.

=item B<--include-json>=I<modulename>, B<-I>

Include extra modules (JSON-encoded).

See C<--include>.

=item B<--include-list>=I<filename>

Include extra modules from a list in a file.

=item B<--include-prereq-json>=I<s>

See C<--include-prereq>.

=item B<--include-prereq>=I<s@>

Include module and its recursive dependencies for fatpacking.

This option can be used to include a module, as well as other modules in the
same distribution as that module, as well as the distribution's recursive
dependencies, for fatpacking. Dependencies will be searched using a local CPAN
index. This is a convenient alternative to tracing a module. So you might want
to use this option together with setting `trace_method` to `none`.

This option requires that `lcpan` is installed and a fairly recent lcpan index
is available.


Can be specified multiple times.

=item B<--include>=I<modulename>

Include an extra module.

When the tracing process fails to include a required module, you can add it
here.


Can be specified multiple times.

=item B<--no-exclude-core>

Do not exclude core modules.

=item B<--no-skip-not-found>

Instead of skipping, die when module to add is not found.

This option is useful when you use `include_prereq`, because modules without its
own .pm files will also be included (CPAN indexes packages, including those that
do not have their own .pm files).


=item B<--trace-extra-opts-json>=I<s>

Pass more options to `App::tracepm` (JSON-encoded).

See C<--trace-extra-opts>.

=item B<--trace-extra-opts>=I<s>

Pass more options to `App::tracepm`.

=item B<--trace-method>=I<s>, B<-t>

Which method to use to trace dependencies.

Default value:

 "fatpacker"

Valid values:

 ["fatpacker","require","prereqscanner","prereqscanner_lite","prereqscanner_recurse","prereqscanner_lite_recurse","none"]

The default is `fatpacker`, which is the same as what `fatpack trace` does.
Different tracing methods have different pro's and con's, one method might
detect required modules that another method does not, and vice versa. There are
several methods available, please see `App::tracepm` for more details.

A special value of `none` is also provided. If this is selected, then fatten
will not perform any tracing. Usually used in conjunction with `--include-from`.


=item B<--use-json>=I<modulename>

Additional modules to "use" (JSON-encoded).

See C<--use>.

=item B<--use>=I<modulename>

Additional module to "use".

Will be passed to the tracer. Will currently only affect the `fatpacker` and
`require` methods (because those methods actually run your script).


Can be specified multiple times.

=back

=head2 Output options

=over

=item B<--format>=I<s>

Choose output format, e.g. json, text.

Default value:

 undef

=item B<--json>

Set output format to json.

=item B<--naked-res>

When outputing as JSON, strip result envelope.

Default value:

 0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd
element) as well as result metadata/extra result (4th element) instead of just
the result (3rd element). However, sometimes you want just the result, e.g. when
you want to pipe the result for more post-processing. In this case you can use
`--naked-res` so you just get:

    [1,2,3]


=item B<--output-file>=I<filename>, B<-o>

Path to output file.

If input is from stdin, then output defaults to stdout. You can also specify
stdout by using `-`.

Otherwise, defaults to `<script>.fatpack` in source directory. If source
directory happens to be unwritable by the script, will try `<script>.fatpack` in
current directory. If that fails too, will die.


=item B<--overwrite>

Overwrite output if previously exists.

=back

=head2 Stripping options

=over

=item B<--no-stripper-comment>

Set strip_comment=0 (don't strip comments) in Perl::Stripper.

Only relevant when stripping using Perl::Stripper.


=item B<--no-stripper-pod>

Set strip_pod=0 (don't strip POD) in Perl::Stripper.

Only relevant when stripping using Perl::Stripper.


=item B<--no-stripper-ws>

Set strip_ws=0 (don't strip whitespace) in Perl::Stripper.

Only relevant when stripping using Perl::Stripper.


=item B<--squish>

Squish included modules using Perl::Squish.

=item B<--strip>

Strip included modules using Perl::Strip.

=item B<--stripper>

Strip included modules using Perl::Stripper.

=item B<--stripper-log>

Set strip_log=1 (strip log statements) in Perl::Stripper.

Only relevant when stripping using Perl::Stripper.


=item B<--stripper-maintain-linum>

Set maintain_linum=1 in Perl::Stripper.

Only relevant when stripping using Perl::Stripper.


=back

=head2 Testing options

=over

=item B<--test>, B<-T>

Test the resulting output.

Testing is done by running the resulting fatpacked result with `perl
-Mlib::core::only`. To test, at least one test case is required (see
`--test-case-json`). Test cases specify what arguments to give to program, what
exit code we expect, and what the output should contain.


=item B<--test-cases-json>=I<s>

See C<--test-cases>.

=item B<--test-cases>=I<s>

Example case:

    {"args":["--help"], "exit_code":0, "perl_args":["-Mlib::core::only"], "output_like":"Usage:"}


=back

=head2 Other options

=over

=item B<--allow-xs-json>=I<s>

See C<--allow-xs>.

=item B<--allow-xs>=I<s@>

Allow adding a specified XS module.

Can be specified multiple times.

=item B<--arg>=I<s@>

Script argument.

Will be used when running your script, e.g. when `trace_method` is `fatpacker`
or `require`. For example, if your script requires three arguments: `--foo`,
`2`, `"bar baz"` then you can either use:

    % fatten script output --args --foo --args 2 --args "bar baz"

or:

    % fatten script output --args-json '["--foo",2,"bar baz"]'


Can be specified multiple times.

=item B<--args-json>=I<s>

Script arguments (JSON-encoded).

See C<--arg>.

=item B<--help>, B<-h>, B<-?>

Display help message and exit.

=item B<--input-file>=I<filename>, B<-i>

Path to input file (script to be fatpacked).

Default value:

 "-"

`-` (or if unspecified) means to take from standard input (internally, a
temporary file will be created to handle this).


=item B<--multiple-runs-json>=I<s>

Pass to tracepm (JSON-encoded).

See C<--multiple-runs>.

=item B<--multiple-runs>=I<s>

Pass to tracepm.

=item B<--perl-version>=I<s>, B<-V>

Perl version to target, defaults to current running version.

This is for determining which modules are considered core and should be skipped
by default (when `exclude_core` option is enabled). Different perl versions have
different sets of core modules as well as different versions of the modules.


=item B<--shebang>=I<s>

Set shebang line/path.

Default value:

 "/usr/bin/perl"

=item B<--version>, B<-v>

Display program's version and exit.

=back

=head1 SEE ALSO

L<App::FatPacker>

For producing free-standing Perl scripts/applications, there are other
alternatives like L<PAR::Packer> (can also pack XS modules and compress the
included files in a special archive, but with higher startup time and temporary
directory to extract stuffs).

L<Perl::Stripper>

=head1 COMPLETION

This script has shell tab completion capability with support for several
shells.

=head2 bash

To activate bash completion for this script, put:

 complete -C fatten fatten

in your bash startup (e.g. C<~/.bashrc>). Your next shell session will then
recognize tab completion for the command. Or, you can also directly execute the
line above in your shell to activate immediately.

It is recommended, however, that you install L<shcompgen> which allows you to
activate completion scripts for several kinds of scripts on multiple shells.
Some CPAN distributions (those that are built with
L<Dist::Zilla::Plugin::GenShellCompletion>) will even automatically enable shell
completion for their included scripts (using C<shcompgen>) at installation time,
so you can immadiately have tab completion.

=head2 tcsh

To activate tcsh completion for this script, put:

 complete fatten 'p/*/`fatten`/'

in your tcsh startup (e.g. C<~/.tcshrc>). Your next shell session will then
recognize tab completion for the command. Or, you can also directly execute the
line above in your shell to activate immediately.

It is also recommended to install C<shcompgen> (see above).

=head2 other shells

For fish and zsh, install C<shcompgen> as described above.

=head1 ENVIRONMENT

=over

=item * FATTEN_OPT

Specify additional command-line options

=back

=head1 CONFIGURATION FILE

This script can read configuration file, which by default is searched at C<~/.config/fatten.conf>, C<~/fatten.conf> or C</etc/fatten.conf> (can be changed by specifying C<--config-path>). All found files will be read and merged.

To disable searching for configuration files, pass C<--no-config>.

Configuration file is in the format of L<IOD>, which is basically INI with some extra features. 

You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]>. Those sections will only be read if you specify the matching C<--config-profile SOMENAME>.

List of available configuration parameters:

 allow_xs (see --allow-xs)
 args (see --arg)
 debug_keep_tempdir (see --debug-keep-tempdir)
 exclude (see --exclude)
 exclude_core (see --no-exclude-core)
 exclude_dist (see --exclude-dist)
 exclude_list (see --exclude-list)
 exclude_pattern (see --exclude-pattern)
 exclude_prereq (see --exclude-prereq)
 format (see --format)
 include (see --include)
 include_dir (see --include-dir)
 include_dist (see --include-dist)
 include_list (see --include-list)
 include_prereq (see --include-prereq)
 input_file (see --input-file)
 log_level (see --log-level)
 multiple_runs (see --multiple-runs)
 naked_res (see --naked-res)
 output_file (see --output-file)
 overwrite (see --overwrite)
 perl_version (see --perl-version)
 shebang (see --shebang)
 skip_not_found (see --no-skip-not-found)
 squish (see --squish)
 strip (see --strip)
 stripper (see --stripper)
 stripper_comment (see --no-stripper-comment)
 stripper_log (see --stripper-log)
 stripper_maintain_linum (see --stripper-maintain-linum)
 stripper_pod (see --no-stripper-pod)
 stripper_ws (see --no-stripper-ws)
 test (see --test)
 test_cases (see --test-cases)
 trace_extra_opts (see --trace-extra-opts)
 trace_method (see --trace-method)
 use (see --use)

Profiles are also automatically matched to the name of the script being
processed, if not specified. For example:

 [profile=parse-id-phone]
 trace_method=require
 #overwrite=1
 include=Parse::PhoneNumber::ID
 include=Perinci::CmdLine::Lite
 include=Data::Check::Structure
 include=Text::Table::Tiny

which will automatically be used when you fatten a script named
C<parse-id-phone>.

=head1 FILES

~/.config/fatten.conf

~/fatten.conf

/etc/fatten.conf

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/App-fatten>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-App-fatten>.

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-fatten>

When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut
