The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
App-ScanPrereqs-0.005
River stage one • 2 direct dependents • 2 total dependents
/ scan-prereqs

NAME

scan-prereqs - Scan files/directories for prerequisites

VERSION

This document describes version 0.005 of scan-prereqs (from Perl distribution App-ScanPrereqs), released on 2019-07-31.

SYNOPSIS

Usage:

 % scan-prereqs [options] [file] ...

Examples:

By default scan current directory:

 % scan-prereqs

DESCRIPTION

This is an alternative CLI to scan_prereqs, with the following features:

  • merged output

scan_prereqs by default reports prereqs per source file, which may or may not be what you want. This CLI outputs a single list of prerequisites found from all input.

Aside from that, you can use --json to get a JSON output.

  • option to pick backend

Aside from Perl::PrereqScanner you can also use Perl::PrereqScanner::Lite and Perl::PrereqScanner::NotQuiteLite.

  • filter only core or non-core prerequisites.

OPTIONS

* marks required options.

Main options

--file=s@

Default value:

 ["."]

Can be specified multiple times.

--files-json=s

See --file.

--no-show-core
--no-show-noncore
--perlver=s

Perl version to use when determining core/non-core.

The default is the current perl version.

--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> 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`.

Read respective scanner's documentation for more details about the pro's and con's for each scanner.

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:

 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]

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 scan-prereqs scan-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 scan-prereqs 'p/*/`scan-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): ~/.config/scan-prereqs.conf, ~/scan-prereqs.conf, or /etc/scan-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:

 files (see --file)
 format (see --format)
 log_level (see --log-level)
 naked_res (see --naked-res)
 perlver (see --perlver)
 scanner (see --scanner)
 show_core (see --no-show-core)
 show_noncore (see --no-show-noncore)

ENVIRONMENT

SCAN_PREREQS_OPT => str

Specify additional command-line options.

FILES

~/.config/scan-prereqs.conf

~/scan-prereqs.conf

/etc/scan-prereqs.conf

HOMEPAGE

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

SOURCE

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

BUGS

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

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 software is copyright (c) 2019, 2017 by 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.