- CONFIGURATION FILE
- COPYRIGHT AND LICENSE
lint-prereqs - Check extraneous/missing prerequisites in dist.ini
This document describes version 0.32 of lint-prereqs (from Perl distribution App-LintPrereqs), released on 2015-10-18.
% lint-prereqs [options]
[Prereqs / *] (as well as
Extras/lint-prereqs/Assume-*) sections in your
dist.ini against what's actually being used in your Perl code (using
Perl::PrereqScanner::Lite) and what's in Perl core list of modules. Will complain if your prerequisites are not actually used, or already in Perl core. Will also complain if there are missing prerequisites.
Designed to work with prerequisites that are manually written. Does not work if you use AutoPrereqs.
Sometimes there are prerequisites that you know are used but can't be detected by scan_prereqs, or you want to include anyway. If this is the case, you can instruct lint_prereqs to assume 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 you know are already provided by some other modules. So to make lint-prereqs ignore them:
[Extras / lint-prereqs / assume-provided] Qux::Quux=0
By default, core modules are not allowed to be specified. Sometimes though you need to specify because on some systems some core modules are not available (e.g. they are split into separate OS packages). In this case, you can specify:
;!lint_prereqs allow-core Data::Dumper=0
* marks required options.
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:
- --help, -h, -?
Display help message and exit.
Use Perl::PrereqScanner instead of Perl::PrereqScanner::Lite.
Lite is faster but it might still miss detecting some modules.
Perl version to use (overrides scan_prereqs/dist.ini).
- --version, -v
Display program's version and exit.
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.
LINT_PREREQS_OPT => str
Specify additional command-line options
This script can read configuration file, which by default is searched at
/etc/lint-prereqs.conf (can be changed by specifying
--config-path). All found files will be read and merged.
To disable searching for configuration files, pass
Configuration file is in the format of IOD, which is basically INI with some extra features.
You can put multiple profiles in a single file by using section names like
[profile=SOMENAME]. Those sections will only be read if you specify the matching
List of available configuration parameters:
format (see --format) lite (see --no-lite) log_level (see --log-level) naked_res (see --naked-res) perl_version (see --perl-version)
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.
COPYRIGHT AND LICENSE
This software is copyright (c) 2015 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.