lint-prereqs - Check extraneous/missing/incorrect prerequisites in dist.ini
This document describes version 0.47 of lint-prereqs (from Perl distribution App-LintPrereqs), released on 2016-11-25.
% lint-prereqs [options]
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).
Sections that will be checked for prereqs include
[Prereqs / *], as well as
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::Any::IfLOG=0.07 ...
then if there is a prereq specified less than the minimum versions,
lint-prereqs will also complain.
* marks required options.
Add extra directories to scan for runtime requirements.
Can be specified multiple times.
Add extra directories to scan for runtime requirements (JSON-encoded).
Add extra directories to scan for test requirements.
Can be specified multiple times.
Add extra directories to scan for test requirements (JSON-encoded).
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.
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 to use (overrides scan_prereqs/dist.ini).
Which scanner to use.
`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`.
Set path to configuration file.
Can be specified multiple times.
Set configuration profile to use.
Do not use any configuration file.
Do not read environment for default options.
Set log level to debug (note: you also need to set LOG=1 to enable logging, or use DEBUG=1).
Set log level (note: you also need to set LOG=1 to enable logging).
Set log level to quiet (note: you also need to set LOG=1 to enable logging, or use QUIET=1).
Set log level to trace (note: you also need to set LOG=1 to enable logging, or use TRACE=1).
Set log level to info (note: you also need to set LOG=1 to enable logging, or use VERBOSE=1).
Choose output format, e.g. json, text.
Set output format to json.
When outputing as JSON, strip result envelope.
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
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:
This script has shell tab completion capability with support for several shells.
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 shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using
shcompgen) at installation time, so you can immadiately have tab completion.
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).
For fish and zsh, install
shcompgen as described above.
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
You can put multiple profiles in a single file by using section names like
[SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching
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)
Specify additional command-line options
Please visit the project's homepage at https://metacpan.org/release/App-LintPrereqs.
Source repository is at https://github.com/perlancar/perl-App-LintPrereqs.
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.
This software is copyright (c) 2016 by email@example.com.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.