1Dist::Zilla::Role::FileUFsienrdeCro(n3t)ributed Perl DocDuimsetn:t:aZtiilolna::Role::FileFinder(3)
2
3
4
6 Dist::Zilla::Role::FileFinder - something that finds files within the
7 distribution
8
10 version 6.031
11
13 A FileFinder plugin locates files within the distribution. This role
14 exists so that sets of files can be easily described in one
15 configuration section and then used by one or more other plugin.
16
17 Plugins implementing this role must provide a "find_files" method which
18 will be called with no arguments and must return an arrayref of files.
19 (This arrayref should not be re-used, as it may be altered once
20 returned.)
21
22 For example, imagine a simple glob-like FileFinder that expects
23 configuration like this:
24
25 [Glob / RootModules]
26 glob = *.pm
27
28 This sets up a FileFinder named "RootModules" which will contain all pm
29 files in the root directory.
30
31 Another plugin that knows how to use FileFinder plugins might be
32 configured like this:
33
34 [ModuleRelocator]
35 finder = RootModules
36 relocate_to = attic
37
38 Finders may operate on any rules they like, checking file size,
39 content, name, or other properties. They should re-perform their
40 "finding" on each call to "find_files" as the files in the distribution
41 may have changed.
42
44 This module should work on any version of perl still receiving updates
45 from the Perl 5 Porters. This means it should work on any version of
46 perl released in the last two to three years. (That is, if the most
47 recently released version is v5.40, then this module should work on
48 both v5.40 and v5.38.)
49
50 Although it may work on older versions of perl, no guarantee is made
51 that the minimum required version will not be increased. The version
52 may be increased for any reason, and there is no promise that patches
53 will be accepted to lower the minimum required perl.
54
56 Ricardo SIGNES 😏 <cpan@semiotic.systems>
57
59 This software is copyright (c) 2023 by Ricardo SIGNES.
60
61 This is free software; you can redistribute it and/or modify it under
62 the same terms as the Perl 5 programming language system itself.
63
64
65
66perl v5.36.1 2023-11-21 Dist::Zilla::Role::FileFinder(3)