.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Dist::Zilla::Role::FileFinderUser 3pm"
.TH Dist::Zilla::Role::FileFinderUser 3pm "2023-01-19" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Dist::Zilla::Role::FileFinderUser \- something that uses FileFinder plugins
.SH "VERSION"
.IX Header "VERSION"
version 6.030
.SH "DESCRIPTION"
.IX Header "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.
.PP
Here's an example of a finder: ( taken from AutoPrereqs )
.PP
.Vb 3
\&  with \*(AqDist::Zilla::Role::FileFinderUser\*(Aq => {
\&      default_finders  => [ \*(Aq:InstallModules\*(Aq, \*(Aq:ExecFiles\*(Aq ],
\&  };
.Ve
.PP
Then you use it in your code like this:
.PP
.Vb 3
\&  foreach my $file ( @{ $self\->found_files }) {
\&    # $file is an object! Look at L<Dist::Zilla::Role::File>
\&  }
.Ve
.SH "PERL VERSION"
.IX Header "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.)
.PP
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.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "finder_arg_names"
.IX Subsection "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!
.PP
This is an ArrayRef.
.PP
Default: [ qw( finder ) ]
.SS "default_finders"
.IX Subsection "default_finders"
This attribute is an arrayref of plugin names for the default plugins the
consuming plugin will use as finders.
.PP
Example: \f(CW\*(C`[ qw( :InstallModules :ExecFiles ) ]\*(C'\fR
.PP
The default finders are:
.IP ":InstallModules" 4
.IX Item ":InstallModules"
Searches your lib/ directory for pm/pod files
.IP ":IncModules" 4
.IX Item ":IncModules"
Searches your inc/ directory for pm files
.IP ":MainModule" 4
.IX Item ":MainModule"
Finds the \f(CW\*(C`main_module\*(C'\fR of your dist
.IP ":TestFiles" 4
.IX Item ":TestFiles"
Searches your t/ directory and lists the files in it.
.IP ":ExtraTestFiles" 4
.IX Item ":ExtraTestFiles"
Searches your xt/ directory and lists the files in it.
.IP ":ExecFiles" 4
.IX Item ":ExecFiles"
Searches your distribution for executable files.  Hint: Use the
Dist::Zilla::Plugin::ExecDir plugin to mark those files as executables.
.IP ":PerlExecFiles" 4
.IX Item ":PerlExecFiles"
A subset of \f(CW\*(C`:ExecFiles\*(C'\fR limited just to perl scripts (those ending with
\&\fI.pl\fR, or with a recognizable perl shebang).
.IP ":ShareFiles" 4
.IX Item ":ShareFiles"
Searches your ShareDir directory and lists the files in it.
Hint: Use the Dist::Zilla::Plugin::ShareDir plugin to set up the sharedir.
.IP ":AllFiles" 4
.IX Item ":AllFiles"
Returns all files in the distribution.
.IP ":NoFiles" 4
.IX Item ":NoFiles"
Returns nothing.
.SS "method"
.IX Subsection "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!
.PP
Default: found_files
.SH "AUTHOR"
.IX Header "AUTHOR"
Ricardo \s-1SIGNES\s0 😏 <cpan@semiotic.systems>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2023 by Ricardo \s-1SIGNES.\s0
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.