Manual Reference Pages - DIST::ZILLA::PLUGIN::GATHERDIR (3)
Dist::Zilla::Plugin::GatherDir - gather all the files in a directory
This is a very, very simple FileGatherer
plugin. It looks in the directory named in the root attribute and adds all
the files it finds there. If the root begins with a tilde, the tilde is
replaced with the current users home directory according to File::HomeDir.
Almost every dist will be built with one GatherDir plugin, since its the
easiest way to get files from disk into your dist. Most users just need:
...and this will pick up all the files from the current directory into the
dist. You can use it multiple times, as you can any other plugin, by providing
a plugin name. For example, if you want to include external specification
files into a subdir of your dist, you might write:
; this plugin needs no config and gathers most of your files
[GatherDir / SpecFiles]
; this plugin gets all the files in the root dir and adds them under ./spec
root = ~/projects/my-project/spec
prefix = spec
This is the directory in which to look for files. If not given, it defaults to
the dist root generally, the place where your dist.ini or other
configuration file is located.
This parameter can be set to gather all the files found under a common
directory. See the description above for an example.
By default, files will not be included if they begin with a dot. This goes
both for files and for directories relative to the root.
In almost all cases, the default value (false) is correct.
By default, directories that are symlinks will not be followed. Note on the
other hand that in all followed directories, files which are symlinks are
To exclude certain files from being gathered, use the exclude_filename
option. This may be used multiple times to specify multiple files to exclude.
This is just like exclude_filename but provides a regular expression
pattern. Files matching the pattern are not gathered. This may be used
multiple times to specify multiple patterns to exclude.
Ricardo SIGNES <firstname.lastname@example.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2013 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.
|perl v5.20.3 ||DIST::ZILLA::PLUGIN::GATHERDIR (3) ||2013-01-31 |
Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.