1Dist::Zilla::Plugin::GaUtsheerrDCiorn(t3r)ibuted Perl DoDciusmte:n:tZaitliloan::Plugin::GatherDir(3)
2
3
4

NAME

6       Dist::Zilla::Plugin::GatherDir - gather all the files in a directory
7

VERSION

9       version 6.031
10

DESCRIPTION

12       This is a very, very simple FileGatherer plugin.  It looks in the
13       directory named in the "root" attribute and adds all the files it finds
14       there.  If the root begins with a tilde, the tilde is passed through
15       glob() first.
16
17       Almost every dist will be built with one GatherDir plugin, since it's
18       the easiest way to get files from disk into your dist.  Most users just
19       need:
20
21         [GatherDir]
22         [PruneCruft]
23
24       ...and this will pick up all the files from the current directory into
25       the dist.  (PruneCruft is needed, here, to drop files that might
26       present as build artifacts, but should not be shipped.)  You can use it
27       multiple times, as you can any other plugin, by providing a plugin
28       name.  For example, if you want to include external specification files
29       into a subdir of your dist, you might write:
30
31         [GatherDir]
32         ; this plugin needs no config and gathers most of your files
33
34         [GatherDir / SpecFiles]
35         ; this plugin gets all the files in the root dir and adds them under ./spec
36         root   = ~/projects/my-project/spec
37         prefix = spec
38

PERL VERSION

40       This module should work on any version of perl still receiving updates
41       from the Perl 5 Porters.  This means it should work on any version of
42       perl released in the last two to three years.  (That is, if the most
43       recently released version is v5.40, then this module should work on
44       both v5.40 and v5.38.)
45
46       Although it may work on older versions of perl, no guarantee is made
47       that the minimum required version will not be increased.  The version
48       may be increased for any reason, and there is no promise that patches
49       will be accepted to lower the minimum required perl.
50

ATTRIBUTES

52   root
53       This is the directory in which to look for files.  If not given, it
54       defaults to the dist root -- generally, the place where your dist.ini
55       or other configuration file is located.
56
57   prefix
58       This parameter can be set to place the gathered files under a
59       particular directory.  See the description above for an example.
60
61   include_dotfiles
62       By default, files will not be included if they begin with a dot.  This
63       goes both for files and for directories relative to the "root".
64
65       In almost all cases, the default value (false) is correct.
66
67   follow_symlinks
68       By default, symlinks pointing to directories will not be followed; set
69       "follow_symlinks = 1" to traverse these links as if they were normal
70       directories.
71
72       In all followed directories, files which are symlinks are always
73       gathered, with the link turning into a normal file.
74
75   exclude_filename
76       To exclude certain files from being gathered, use the
77       "exclude_filename" option.  The filename is matched exactly, relative
78       to "root".  This may be used multiple times to specify multiple files
79       to exclude.
80
81   exclude_match
82       This is just like "exclude_filename" but provides a regular expression
83       pattern.  Filenames matching the pattern (relative to "root")  are not
84       gathered.  This may be used multiple times to specify multiple patterns
85       to exclude.
86
87   prune_directory
88       While traversing, any directory matching the regular expression pattern
89       will not be traversed further. This may be used multiple times to
90       specify multiple directories to skip.
91

AUTHOR

93       Ricardo SIGNES 😏 <cpan@semiotic.systems>
94

96       This software is copyright (c) 2023 by Ricardo SIGNES.
97
98       This is free software; you can redistribute it and/or modify it under
99       the same terms as the Perl 5 programming language system itself.
100
101
102
103perl v5.38.0                      2023-11-21 Dist::Zilla::Plugin::GatherDir(3)
Impressum