NAME

lint-prereqs - Check extraneous/missing/incorrect prerequisites in dist.ini

VERSION

This document describes version 0.543 of lint-prereqs (from Perl distribution App-LintPrereqs), released on 2020-04-27.

SYNOPSIS

Usage:

% lint-prereqs [-F] [--config-path=s | -c] [--config-profile=s | -P]
    [--core-prereqs] [--debug] [--extra-runtime-dir=s+]
    [--extra-runtime-dirs-json=s] [--extra-test-dir=s+]
    [--extra-test-dirs-json=s] [--fix] [--format=s] [--json]
    [--log-level=s] [--(no)naked-res] [--no-config | -C]
    [--no-core-prereqs] [--no-env] [--no-fix] [--nocore-prereqs] [--nofix]
    [--page-result[=s]] [--perl-version=s] [--quiet] [--scanner=s]
    [--trace] [--verbose]

DESCRIPTION

lint-prereqs can improve your prereqs specification in dist.ini by reporting prereqs that are extraneous (specified but unused), missing (used/required but not specified), or incorrect (mismatching version between what's specified in dist.ini vs in source code, incorrect phase like test prereqs specified in runtime, etc).

Checking actual usage of prereqs is done using Perl::PrereqScanner (or Perl::PrereqScanner::Lite).

Sections that will be checked for prereqs include [Prereqs / *], as well as OSPrereqs, Extras/lint-prereqs/Assume-*. Designed to work with prerequisites that are manually written. Does not work if you use AutoPrereqs (using AutoPrereqs basically means that you do not specify prereqs and just use whatever modules are detected by the scanner.)

Sometimes there are prerequisites that you know are used but can't be detected by the scanner, or you want to include anyway. If this is the case, you can instruct lint_prereqs to assume that the prerequisite is used.

;!lint_prereqs assume-used "even though we know it is not currently used"
Foo::Bar=0

;!lint_prereqs assume-used "we are forcing a certain version"
Baz=0.12

Sometimes there are also prerequisites that are detected by scan_prereqs, but are false positives (Perl::PrereqScanner::Lite sometimes does this because its parser is simpler) or you know are already provided by some other modules. So to make lint-prereqs ignore them:

[Extras / lint-prereqs / assume-provided]
Qux::Quux=0

You can also add a [versions] section in your lint-prereqs.conf configuration containing minimum versions that you want for certain modules, e.g.:

[versions]
Bencher=0.30
Log::ger=0.19
...

then if there is a prereq specified less than the minimum versions, lint-prereqs will also complain.

OPTIONS

* marks required options.

Main options

--extra-runtime-dir=s@

Add extra directories to scan for runtime requirements.

Can be specified multiple times.

--extra-runtime-dirs-json=s

Add extra directories to scan for runtime requirements (JSON-encoded).

See --extra-runtime-dir.

--extra-test-dir=s@

Add extra directories to scan for test requirements.

Can be specified multiple times.

--extra-test-dirs-json=s

Add extra directories to scan for test requirements (JSON-encoded).

See --extra-test-dir.

--fix, -F

Attempt to automatically fix the errors.

`lint-prereqs` can attempt to automatically fix the errors by adding/removing/moving prereqs in `dist.ini`. Not all errors can be automatically fixed. When modifying `dist.ini`, a backup in `dist.ini~` will be created.

--no-core-prereqs

If set to 0 (the default), will complain if there are prerequisites to core modules. If set to 1, prerequisites to core modules are required just like other modules.

--perl-version=s

Perl version to use (overrides scan_prereqs/dist.ini).

--scanner=s

Which scanner to use.

Default value:

"regular"

Valid values:

["regular","lite","nqlite"]

`regular` means <pm:Perl::PrereqScanner> which is PPI-based and is the slowest but has the most complete support for Perl syntax.

`lite` means <pm:Perl::PrereqScanner::Lite> has uses an XS-based lexer and is the fastest but might miss some Perl syntax (i.e. miss some prereqs) or crash if given some weird code.

`nqlite` means <pm:Perl::PrereqScanner::NotQuiteLite> which is faster than `regular` but not as fast as `lite`.

Configuration options

--config-path=s, -c: Set path to configuration file.
--config-profile=s, -P: Set configuration profile to use.
--no-config, -C: Do not use any configuration file.

Environment options

--no-env: Do not read environment for default options.

Logging options

--debug: Shortcut for --log-level=debug.
--log-level=s: Set log level.
--quiet: Shortcut for --log-level=error.
--trace: Shortcut for --log-level=trace.
--verbose: Shortcut for --log-level=info.

Output options

--format=s

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

Default value:

undef

--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

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.

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 lint-prereqs lint-prereqs

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 lint-prereqs 'p/*/`lint-prereqs`/'

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/lint-prereqs.conf, /home/u1/lint-prereqs.conf, /etc/lint-prereqs.conf, or ./lint-prereqs.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.

Finally, you can 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 has value equals something: [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 something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [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.

List of available configuration parameters:

core_prereqs (see --no-core-prereqs)
extra_runtime_dirs (see --extra-runtime-dir)
extra_test_dirs (see --extra-test-dir)
fix (see --fix)
format (see --format)
log_level (see --log-level)
naked_res (see --naked-res)
perl_version (see --perl-version)
scanner (see --scanner)

ENVIRONMENT

LINT_PREREQS_OPT => str

Specify additional command-line options.

FILES

/home/u1/.config/lint-prereqs.conf

/home/u1/lint-prereqs.conf

/etc/lint-prereqs.conf

./lint-prereqs.conf

HOMEPAGE

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

SOURCE

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

BUGS

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

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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

To install App::LintPrereqs, copy and paste the appropriate command in to your terminal.

cpanm

cpanm App::LintPrereqs

CPAN shell

perl -MCPAN -e shell
install App::LintPrereqs

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

SYNOPSIS

DESCRIPTION

OPTIONS

Main options

Configuration options

Environment options

Logging options

Output options

Other options

COMPLETION

bash

tcsh

other shells

CONFIGURATION FILE

ENVIRONMENT

LINT_PREREQS_OPT => str

FILES

HOMEPAGE

SOURCE

BUGS

AUTHOR

COPYRIGHT AND LICENSE

Module Install Instructions