NAME

Dist::Zilla::Plugin::AutoPrereqs - automatically extract prereqs from your modules

VERSION

version 6.031

SYNOPSIS

In your dist.ini:

  [AutoPrereqs]
  skip = ^Foo|Bar$
  skip = ^Other::Dist

DESCRIPTION

This plugin will extract loosely your distribution prerequisites from your files using Perl::PrereqScanner.

If some prereqs are not found, you can still add them manually with the Prereqs plugin.

This plugin will skip the modules shipped within your dist.

Note, if you have any non-Perl files in your t/ directory or other directories being scanned, be sure to mark those files' encoding as bytes with the Encoding plugin so they won't be scanned:

    [Encoding]
    encoding = bytes
    match    = ^t/data/

PERL VERSION

This module should work on any version of perl still receiving updates from the Perl 5 Porters. This means it should work on any version of perl released in the last two to three years. (That is, if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38.)

Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.

ATTRIBUTES

finder

This is the name of a FileFinder whose files will be scanned to determine runtime prerequisites. It may be specified multiple times. The default value is :InstallModules and :ExecFiles.

test_finder

Just like finder, but for test-phase prerequisites. The default value is :TestFiles.

configure_finder

Just like finder, but for configure-phase prerequisites. There is no default value; AutoPrereqs will not determine configure-phase prerequisites unless you set configure_finder.

develop_finder

Just like finder, but for develop-phase prerequisites. The default value is :ExtraTestFiles.

skips

This is an arrayref of regular expressions, derived from all the 'skip' lines in the configuration. Any module names matching any of these regexes will not be registered as prerequisites.

relationship

The relationship used for the registered prerequisites. The default value is 'requires'; other options are 'recommends' and 'suggests'.

extra_scanners

This is an arrayref of scanner names (as expected by Perl::PrereqScanner). It will be passed as the extra_scanners parameter to Perl::PrereqScanner.

scanners

This is an arrayref of scanner names (as expected by Perl::PrereqScanner). If present, it will be passed as the scanners parameter to Perl::PrereqScanner, which means that it will replace the default list of scanners.

SEE ALSO

Prereqs, Perl::PrereqScanner.

CREDITS

This plugin was originally contributed by Jerome Quelin.

AUTHOR

Ricardo SIGNES 😏 <cpan@semiotic.systems>

COPYRIGHT AND LICENSE

This software is copyright (c) 2023 by Ricardo SIGNES.

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