NAME

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

VERSION

       version 5.043

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>
         }

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@cpan.org>

COPYRIGHT AND LICENSE

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

perl v5.22.1                                       2016-01-21             Dist::Zilla::Role::FileFinderUser(3pm)