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

ATTRIBUTES

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

AUTHOR

89       Ricardo SIGNES 😏 <rjbs@cpan.org>
90

92       This software is copyright (c) 2018 by Ricardo SIGNES.
93
94       This is free software; you can redistribute it and/or modify it under
95       the same terms as the Perl 5 programming language system itself.
96
97
98
99perl v5.28.1                      2018-04-2D1ist::Zilla::Role::FileFinderUser(3)
Impressum