/ 
App-tracepm-0.231
River stage one • 2 direct dependents • 6 total dependents
/ tracepm

NAME

tracepm - Trace dependencies of your Perl script

VERSION

This document describes version 0.231 of tracepm (from Perl distribution App-tracepm), released on 2023-07-11.

SYNOPSIS

tracepm --help (or -h, -?)

tracepm --version (or -v)

tracepm [--cache-prereqscanner|--no-cache-prereqscanner|--nocache-prereqscanner] [--config-path=path|-c|--no-config|-C] [--config-profile=profile|-P] [--core|--no-core|--nocore] [--detail|-l|--no-detail|--nodetail] [--eval=str|-e=str] [--format=name|--json] [--method=str] [--module=perl::modname|-m=perl::modname] [--multiple-runs=hash|--multiple-runs-json=json] [--(no)naked-res] [--no-env] [--page-result[=program]|--view-result[=program]] [--perl-version=str|-V=str] [--recurse-exclude-core|--no-recurse-exclude-core|--norecurse-exclude-core] [(--recurse-exclude-pattern=str)+|--recurse-exclude-pattern-json=json] [--recurse-exclude-xs|--no-recurse-exclude-xs|--norecurse-exclude-xs] [(--recurse-exclude=str)+|--recurse-exclude-json=json] [--trap-script-output] [(--use=str)+|--use-json=json] [--xs|--no-xs|--noxs] -- [script] [args] ...

OPTIONS

* marks required options.

Main options

--args-json=s

Script arguments (JSON-encoded).

See --args.

Can also be specified as the 2nd command-line argument and onwards.

--args=s@

Script arguments.

Can also be specified as the 2nd command-line argument and onwards.

Can be specified multiple times.

--cache-prereqscanner

Whether cache Perl::PrereqScanner{,::Lite} result.

--method=s

Tracing method to use.

Default value:

"fatpacker"

Valid values:

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

There are several tracing methods that can be used:

  • fatpacker (the default): This method uses the same method that fatpacker trace uses, which is running the script using perl -c then collect the populated %INC. Only modules loaded during compile time are detected.

  • require: This method runs your script normally until it exits. At the start of program, it replaces CORE::GLOBAL::require() with a routine that logs the require() argument to the log file. Modules loaded during runtime is also logged by this method. But some modules might not work, specifically modules that also overrides require() (there should be only a handful of modules that do this though).

  • prereqscanner: This method does not run your Perl program, but statically analyze it using Perl::PrereqScanner. Since it uses PPI, it can be rather slow.

  • prereqscanner_recurse: Like prereqscanner, but will recurse into all non-core modules until they are exhausted. Modules that are not found will be skipped. It is recommended to use the various recurse_exclude_* options options to limit recursion.

  • prereqscanner_lite: This method is like the prereqscanner method, but instead of Perl::PrereqScanner it uses Perl::PrereqScanner::Lite. The latter does not use PPI but use Compiler::Lexer which is significantly faster.

  • prereqscanner_lite_recurse: Like prereqscanner_lite, but recurses.

--multiple-runs-json=s

Parameter to run script multiple times (JSON-encoded).

See --multiple-runs.

--multiple-runs=s

Parameter to run script multiple times.

A more general alternative to using args. Script will be run multiple times, each with setting from element of this option.

Can be used to reach multiple run pathways and trace more modules.

Example:

[{"args":["-h"]}, # help mode
 {"args":[""], "env":{"COMP_LINE":"cmd x", "COMP_POINT":5}},
],
--perl-version=s, -V

Perl version, defaults to current running version.

This is for determining which module is core (the list differs from version to version. See Module::CoreList for more details.

--recurse-exclude-core

When recursing, exclude core modules.

--recurse-exclude-json=s

When recursing, exclude some modules (JSON-encoded).

See --recurse-exclude.

--recurse-exclude-pattern-json=s

When recursing, exclude some module patterns (JSON-encoded).

See --recurse-exclude-pattern.

--recurse-exclude-pattern=s@

When recursing, exclude some module patterns.

Can be specified multiple times.

--recurse-exclude-xs

When recursing, exclude XS modules.

--recurse-exclude=s@

When recursing, exclude some modules.

Can be specified multiple times.

--trap-script-output

Trap script output so it does not interfere with trace result.

--use-json=s

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

See --use.

--use=s@

Additional modules to "use".

This is like running:

perl -MModule1 -MModule2 script.pl

Can be specified multiple times.

Configuration options

--config-path=s, -c

Set path to configuration file.

Can actually be specified multiple times to instruct application to read from multiple configuration files (and merge them).

--config-profile=s, -P

Set configuration profile to use.

A single configuration file can contain profiles, i.e. alternative sets of values that can be selected. For example:

[profile=dev]
username=foo
pass=beaver

[profile=production]
username=bar
pass=honey

When you specify --config-profile=dev, username will be set to foo and password to beaver. When you specify --config-profile=production, username will be set to bar and password to honey.

--no-config, -C

Do not use any configuration file.

If you specify --no-config, the application will not read any configuration file.

Environment options

--no-env

Do not read environment for default options.

If you specify --no-env, the application wil not read any environment variable.

Field selection options

--detail, -l

Whether to return records instead of just module names.

Filtering options

--core

Filter only modules that are in core.

--xs

Filter only modules that are XS modules.

Input options

--eval=s, -e

Specify script from command-line instead.

--module=s, -m

--module MOD is equivalent to --script 'use MOD'.

--script=s, -s

Path to script file.

Can also be specified as the 1st command-line argument.

Output options

--format=s

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

Default value:

undef

Output can be displayed in multiple formats, and a suitable default format is chosen depending on the application and/or whether output destination is interactive terminal (i.e. whether output is piped). This option specifically chooses an output format.

--json

Set output format to json.

--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]
--page-result

Filter output through a pager.

This option will pipe the output to a specified pager program. If pager program is not specified, a suitable default e.g. less is chosen.

--view-result

View output using a viewer.

This option will first save the output to a temporary file, then open a viewer program to view the temporary file. If a viewer program is not chosen, a suitable default, e.g. the browser, is chosen.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

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

bash

To activate bash completion for this script, put:

complete -C tracepm tracepm

in your bash startup (e.g. ~/.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 modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete tracepm 'p/*/`tracepm`/'

in your tcsh startup (e.g. ~/.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 shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): /home/u1/.config/tracepm.conf, /home/u1/tracepm.conf, or /etc/tracepm.conf.

All found files will be read and merged.

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

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

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

You can also filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable equals some string: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal some string: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. If you only want a section to be read when the value of an environment variable does not include some string: [env=HOSTNAME!*=server ...] or [SOMESECTION env=HOSTNAME!*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:

[plugin=DumpArgs]
-event=before_validate_args
-prio=99

[plugin=Foo]
-event=after_validate_args
arg1=val1
arg2=val2

which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.

List of available configuration parameters:

args (see --args)
cache_prereqscanner (see --cache-prereqscanner)
core (see --core)
detail (see --detail)
eval (see --eval)
format (see --format)
method (see --method)
module (see --module)
multiple_runs (see --multiple-runs)
naked_res (see --naked-res)
perl_version (see --perl-version)
recurse_exclude (see --recurse-exclude)
recurse_exclude_core (see --recurse-exclude-core)
recurse_exclude_pattern (see --recurse-exclude-pattern)
recurse_exclude_xs (see --recurse-exclude-xs)
script (see --script)
trap_script_output (see --trap-script-output)
use (see --use)
xs (see --xs)

ENVIRONMENT

TRACEPM_OPT

String. Specify additional command-line options.

FILES

/home/u1/.config/tracepm.conf

/home/u1/tracepm.conf

/etc/tracepm.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-tracepm.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-tracepm.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023, 2020, 2017, 2016, 2015, 2014 by perlancar <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.

BUGS

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

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.