/ 
App-DzilUtils-0.120
River stage one • 1 direct dependent • 1 total dependent
/ list-dist-deps

NAME

list-dist-deps - List dependencies from dist.ini

VERSION

This document describes version 0.120 of list-dist-deps (from Perl distribution App-DzilUtils), released on 2024-04-17.

SYNOPSIS

% list-dist-deps
% list-dist-deps --phase ALL --rel ALL -R

DESCRIPTION

Check the Prereqs/* sections in your dist.ini and list them. There is an option to do recursive CPAN dependencies by using lcpan.

AutoPrereqs is not supported.

OPTIONS

* marks required options.

Main options

--dont-uniquify

Allow showing multiple modules for different dists.

--flatten

Instead of showing tree-like information, flatten it.

When recursing, the default is to show the final result in a tree-like table, i.e. indented according to levels, e.g.:

% lcpan deps -R MyModule
| module            | author  | version |
|-------------------|---------|---------|
| Foo               | AUTHOR1 | 0.01    |
|   Bar             | AUTHOR2 | 0.23    |
|   Baz             | AUTHOR3 | 1.15    |
| Qux               | AUTHOR2 | 0       |

To be brief, if Qux happens to also depends on Bar, it will not be shown in the result. Thus we don't know the actual Bar version that is needed by the dependency tree of MyModule. For example, if Qux happens to depends on Bar version 0.45 then MyModule indirectly requires Bar 0.45.

To list all the direct and indirect dependencies on a single flat list, with versions already resolved to the largest version required, use the flatten option:

% lcpan deps -R --flatten MyModule
| module            | author  | version |
|-------------------|---------|---------|
| Foo               | AUTHOR1 | 0.01    |
| Bar               | AUTHOR2 | 0.45    |
| Baz               | AUTHOR3 | 1.15    |
| Qux               | AUTHOR2 | 0       |

Note that Bar's required version is already 0.45 in the above example.

--level=s, -l

Recurse for a number of levels (-1 means unlimited).

Default value:

1
--perl-version=s, -V

Set base Perl version for determining core modules.

Default value:

"v5.38.2"
-R

Recurse (alias for `--level -1`).

See --level.

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.

Filtering options

--added-or-updated-since-last-index-update, --since-last-index-update

Include only records that are added/updated since the last index update.

--added-or-updated-since-last-n-index-updates=s, --since-last-n-index-updates

Include only records that are added/updated since the last N index updates.

--added-or-updated-since=s, --since

Include only records that are added/updated since a certain date.

--added-since-last-index-update

Include only records that are added since the last index update.

--added-since-last-n-index-updates=s

Include only records that are added since the last N index updates.

--added-since=s

Include only records that are added since a certain date.

--all

Equivalent to --phase ALL --rel ALL.

See --phase.

--broken

Alias for --exclude-indexed --include-unindexed.

See --exclude-unindexed.

--exclude-core

Exclude core modules.

--exclude-indexed

Exclude modules that are indexed (listed in 02packages.details.txt.gz).

--exclude-noncore

Exclude non-core modules.

--exclude-unindexed

Exclude modules that are not indexed (not listed in 02packages.details.txt.gz).

--phase=s

Default value:

"runtime"
--rel=s

Default value:

"requires"
--updated-since-last-index-update

Include only records that are updated since the last index update.

--updated-since-last-n-index-updates=s

Include only records that are updated since the last N index updates.

--updated-since=s

Include only records that are updated since certain date.

--with-xs-or-pp

Check each dependency as XS/PP.

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 list-dist-deps list-dist-deps

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 list-dist-deps 'p/*/`list-dist-deps`/'

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/dzilutils.ini, /home/u1/dzilutils.ini, or /etc/dzilutils.ini.

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:

added_or_updated_since (see --added-or-updated-since)
added_or_updated_since_last_index_update (see --added-or-updated-since-last-index-update)
added_or_updated_since_last_n_index_updates (see --added-or-updated-since-last-n-index-updates)
added_since (see --added-since)
added_since_last_index_update (see --added-since-last-index-update)
added_since_last_n_index_updates (see --added-since-last-n-index-updates)
dont_uniquify (see --dont-uniquify)
flatten (see --flatten)
format (see --format)
include_core (see --exclude-core)
include_indexed (see --exclude-indexed)
include_noncore (see --exclude-noncore)
include_unindexed (see --exclude-unindexed)
level (see --level)
naked_res (see --naked-res)
perl_version (see --perl-version)
phase (see --phase)
rel (see --rel)
updated_since (see --updated-since)
updated_since_last_index_update (see --updated-since-last-index-update)
updated_since_last_n_index_updates (see --updated-since-last-n-index-updates)
with_xs_or_pp (see --with-xs-or-pp)

ENVIRONMENT

LIST_DIST_DEPS_OPT

String. Specify additional command-line options.

FILES

/home/u1/.config/dzilutils.ini

/home/u1/dzilutils.ini

/etc/dzilutils.ini

HOMEPAGE

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

SOURCE

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

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) 2024, 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-DzilUtils

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.