Scroll to navigation

Dist::Zilla::Role::FileFinderUser(3pm) User Contributed Perl Documentation Dist::Zilla::Role::FileFinderUser(3pm)

NAME

Dist::Zilla::Role::FileFinderUser - something that uses FileFinder plugins

VERSION

version 6.024

DESCRIPTION

This role enables you to search for files in the dist. This makes it easy to find specific files and have the code factored out to common methods.

Here's an example of a finder: ( taken from AutoPrereqs )

  with 'Dist::Zilla::Role::FileFinderUser' => {
      default_finders  => [ ':InstallModules', ':ExecFiles' ],
  };

Then you use it in your code like this:

  foreach my $file ( @{ $self->found_files }) {
    # $file is an object! Look at L<Dist::Zilla::Role::File>
  }

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_arg_names

Define the name of the attribute which will hold this finder. Be sure to specify different names if you have multiple finders!

This is an ArrayRef.

Default: [ qw( finder ) ]

default_finders

This attribute is an arrayref of plugin names for the default plugins the consuming plugin will use as finders.

Example: "[ qw( :InstallModules :ExecFiles ) ]"

The default finders are:

:InstallModules
Searches your lib/ directory for pm/pod files
:IncModules
Searches your inc/ directory for pm files
:MainModule
Finds the "main_module" of your dist
:TestFiles
Searches your t/ directory and lists the files in it.
:ExtraTestFiles
Searches your xt/ directory and lists the files in it.
:ExecFiles
Searches your distribution for executable files. Hint: Use the Dist::Zilla::Plugin::ExecDir plugin to mark those files as executables.
:PerlExecFiles
A subset of ":ExecFiles" limited just to perl scripts (those ending with .pl, or with a recognizable perl shebang).
:ShareFiles
Searches your ShareDir directory and lists the files in it. Hint: Use the Dist::Zilla::Plugin::ShareDir plugin to set up the sharedir.
:AllFiles
Returns all files in the distribution.
:NoFiles
Returns nothing.

method

This will be the name of the subroutine installed in your package for this finder. Be sure to specify different names if you have multiple finders!

Default: found_files

AUTHOR

Ricardo SIGNES 😏 <rjbs@semiotic.systems>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021 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.

2021-11-07 perl v5.32.1