NAME¶
Dist::Zilla::Role::FileFinder - something that finds files within the
distribution
VERSION¶
version 5.020
DESCRIPTION¶
A FileFinder plugin locates files within the distribution. This role exists so
that sets of files can be easily described in one configuration section and
then used by one or more other plugin.
Plugins implementing this role must provide a "find_files" method
which will be called with no arguments and must return an arrayref of files.
(This arrayref should not be re-used, as it may be altered once returned.)
For example, imagine a simple glob-like FileFinder that expects configuration
like this:
[Glob / RootModules]
glob = *.pm
This sets up a FileFinder named "RootModules" which will contain all
pm files in the root directory.
Another plugin that knows how to use FileFinder plugins might be configured like
this:
[ModuleRelocator]
finder = RootModules
relocate_to = attic
Finders may operate on any rules they like, checking file size, content, name,
or other properties. They should re-perform their "finding" on each
call to "find_files" as the files in the distribution may have
changed.
AUTHOR¶
Ricardo SIGNES <rjbs@cpan.org>
COPYRIGHT AND LICENSE¶
This software is copyright (c) 2014 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.