1Dist::Zilla::Role::FileUFsienrdeCroUnsterri(b3u)ted PerlDiDsotc:u:mZeinltlaat:i:oRnole::FileFinderUser(3)
2
3
4

NAME

6       Dist::Zilla::Role::FileFinderUser - something that uses FileFinder
7       plugins
8

VERSION

10       version 6.031
11

DESCRIPTION

13       This role enables you to search for files in the dist. This makes it
14       easy to find specific files and have the code factored out to common
15       methods.
16
17       Here's an example of a finder: ( taken from AutoPrereqs )
18
19         with 'Dist::Zilla::Role::FileFinderUser' => {
20             default_finders  => [ ':InstallModules', ':ExecFiles' ],
21         };
22
23       Then you use it in your code like this:
24
25         foreach my $file ( @{ $self->found_files }) {
26           # $file is an object! Look at L<Dist::Zilla::Role::File>
27         }
28

PERL VERSION

30       This module should work on any version of perl still receiving updates
31       from the Perl 5 Porters.  This means it should work on any version of
32       perl released in the last two to three years.  (That is, if the most
33       recently released version is v5.40, then this module should work on
34       both v5.40 and v5.38.)
35
36       Although it may work on older versions of perl, no guarantee is made
37       that the minimum required version will not be increased.  The version
38       may be increased for any reason, and there is no promise that patches
39       will be accepted to lower the minimum required perl.
40

ATTRIBUTES

42   finder_arg_names
43       Define the name of the attribute which will hold this finder. Be sure
44       to specify different names if you have multiple finders!
45
46       This is an ArrayRef.
47
48       Default: [ qw( finder ) ]
49
50   default_finders
51       This attribute is an arrayref of plugin names for the default plugins
52       the consuming plugin will use as finders.
53
54       Example: "[ qw( :InstallModules :ExecFiles ) ]"
55
56       The default finders are:
57
58       :InstallModules
59           Searches your lib/ directory for pm/pod files
60
61       :IncModules
62           Searches your inc/ directory for pm files
63
64       :MainModule
65           Finds the "main_module" of your dist
66
67       :TestFiles
68           Searches your t/ directory and lists the files in it.
69
70       :ExtraTestFiles
71           Searches your xt/ directory and lists the files in it.
72
73       :ExecFiles
74           Searches your distribution for executable files.  Hint: Use the
75           Dist::Zilla::Plugin::ExecDir plugin to mark those files as
76           executables.
77
78       :PerlExecFiles
79           A subset of ":ExecFiles" limited just to perl scripts (those ending
80           with .pl, or with a recognizable perl shebang).
81
82       :ShareFiles
83           Searches your ShareDir directory and lists the files in it.  Hint:
84           Use the Dist::Zilla::Plugin::ShareDir plugin to set up the
85           sharedir.
86
87       :AllFiles
88           Returns all files in the distribution.
89
90       :NoFiles
91           Returns nothing.
92
93   method
94       This will be the name of the subroutine installed in your package for
95       this finder.  Be sure to specify different names if you have multiple
96       finders!
97
98       Default: found_files
99

AUTHOR

101       Ricardo SIGNES 😏 <cpan@semiotic.systems>
102

104       This software is copyright (c) 2023 by Ricardo SIGNES.
105
106       This is free software; you can redistribute it and/or modify it under
107       the same terms as the Perl 5 programming language system itself.
108
109
110
111perl v5.38.0                      2023-11-2D1ist::Zilla::Role::FileFinderUser(3)
Impressum