-
-
28 May 2022 15:57:31 UTC
- Distribution: Dist-Zilla
- Module version: 6.025
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues (95)
- Testers (693 / 1 / 26)
- Kwalitee
Bus factor: 1- 84.56% Coverage
- License: perl_5
- Perl: v5.20.0
- Activity
24 month- Tools
- Download (347.07KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 111 contributors-
Ricardo SIGNES 😏
-
Ævar Arnfjörð Bjarmason
-
Alastair McGowan-Douglas
-
Alceu Rodrigues de Freitas Junior
-
Alexei Znamensky
-
Alex Vandiver
-
ambs
-
Andrew Rodland
-
Andy Jack
-
Apocalypse
-
ben hengst
-
Bernardo Rechea
-
Brian Fraser
-
Caleb Cushing
-
Chase Whitener
-
Chisel
-
Christian Walde
-
Christopher Bottoms
-
Christopher J. Madsen
-
Chris Weyl
-
Cory G Watson
-
csjewell
-
Curtis Brandt
-
Dagfinn Ilmari Mannsåker
-
Damien KRotkine
-
Dan Book
-
Daniel Böhmer
-
Danijel Tasov
-
Dave Lambley
-
Dave O'Neill
-
Dave Rolsky
-
David E. Wheeler
-
David Golden
-
David H. Adler
-
David Steinbrunner
-
David Zurborg
-
Davor Cubranic
-
Dimitar Petrov
-
Doug Bell
-
Erik Carlsson
-
Fayland Lam
-
Felix Ostmann
-
Florian Ragwitz
-
Fred Moyer
-
fREW Schmidt
-
gardnerm
-
Gianni Ceccarelli
-
Graham Barr
-
Graham Knop
-
Graham Ollis
-
Grzegorz Rożniecki
-
Håkon Hægland
-
Hans Dieter Pearcey
-
Hunter McMillen
-
Ivan Bessarabov
-
Jakob Voss
-
jantore
-
Jérôme Quelin
-
Jesse Luehrs
-
Jesse Vincent
-
JJ Merelo
-
John Napiorkowski
-
jonasbn
-
Jonathan C. Otsuka
-
Jonathan Rockway
-
Jonathan Scott Duff
-
Jonathan Yu
-
Karen Etheridge
-
Kent Fredric
-
Leon Timmermans
-
Lucas Theisen
-
Luc St-Louis
-
Marcel Gruenauer
-
Martin McGrath
-
Mary Ehlers
-
Mateu X Hunter
-
Matthew Horsfall
-
mauke
-
Michael Conrad
-
Michael G. Schwern
-
Michael Jemmeson
-
Mickey Nasriachi
-
Mike Doherty
-
Mohammad S Anwar
-
Moritz Onken
-
Neil Bowers
-
Nickolay Platonov
-
Nick Tonkin
-
nperez
-
Olivier Mengué
-
Paul Cochrane
-
Pedro Melo
-
perlancar (@pc-office)
-
Philippe Bruhat (BooK)
-
raf
-
Randy Stauner
-
robertkrimen
-
Rob Hoelz
-
Robin Smidsrød
-
Roy Ivy III
-
Shawn M Moore
-
Shlomi Fish
-
Smylers
-
Steffen Schwigon
-
Steven Haryanto
-
Tatsuhiko Miyagawa
-
Upasana Shukla
-
Van de Bugger
-
Vyacheslav Matjukhin
-
Yanick Champoux
-
Yuval Kogman
- Dependencies
- App::Cmd::Command::version
- App::Cmd::Setup
- App::Cmd::Tester
- App::Cmd::Tester::CaptureExternal
- Archive::Tar
- CPAN::Meta::Converter
- CPAN::Meta::Merge
- CPAN::Meta::Prereqs
- CPAN::Meta::Requirements
- CPAN::Meta::Validator
- CPAN::Uploader
- Carp
- Config::INI::Reader
- Config::MVP
- Config::MVP::Assembler
- Config::MVP::Assembler::WithBundles
- Config::MVP::Reader
- Config::MVP::Reader::Findable::ByExtension
- Config::MVP::Reader::Finder
- Config::MVP::Reader::INI
- Config::MVP::Section
- Data::Dumper
- Data::Section
- DateTime
- Digest::MD5
- Encode
- ExtUtils::Manifest
- File::Copy::Recursive
- File::Find::Rule
- File::Path
- File::ShareDir
- File::ShareDir::Install
- File::Spec
- File::Temp
- File::pushd
- JSON::MaybeXS
- List::Util
- Log::Dispatchouli
- Mixin::Linewise::Readers
- Module::CoreList
- Module::Runtime
- Moose
- Moose::Role
- Moose::Util::TypeConstraints
- MooseX::LazyRequire
- MooseX::Role::Parameterized
- MooseX::SetOnce
- MooseX::Types
- MooseX::Types::Moose
- MooseX::Types::Perl
- PPI::Document
- Params::Util
- Path::Tiny
- Perl::PrereqScanner
- Pod::Simple
- Scalar::Util
- Software::License
- Software::LicenseUtils
- String::Formatter
- String::RewritePrefix
- Sub::Exporter
- Sub::Exporter::ForMethods
- Sub::Exporter::Util
- Term::ANSIColor
- Term::Encoding
- Term::ReadKey
- Term::ReadLine
- Term::UI
- Test::Deep
- Text::Glob
- Text::Template
- Try::Tiny
- YAML::Tiny
- autodie
- experimental
- feature
- namespace::autoclean
- parent
- utf8
- version
- warnings
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
Dist::Zilla::Plugin::GatherDir - gather all the files in a directory
VERSION
version 6.025
DESCRIPTION
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 passed through
glob()
first.Almost every dist will be built with one GatherDir plugin, since it's the easiest way to get files from disk into your dist. Most users just need:
[GatherDir] [PruneCruft]
...and this will pick up all the files from the current directory into the dist. (PruneCruft is needed, here, to drop files that might present as build artifacts, but should not be shipped.) 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:
[GatherDir] ; 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
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.)
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.
ATTRIBUTES
root
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.
prefix
This parameter can be set to place the gathered files under a particular directory. See the description above for an example.
include_dotfiles
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.
follow_symlinks
By default, symlinks pointing to directories will not be followed; set
follow_symlinks = 1
to traverse these links as if they were normal directories.In all followed directories, files which are symlinks are always gathered, with the link turning into a normal file.
exclude_filename
To exclude certain files from being gathered, use the
exclude_filename
option. The filename is matched exactly, relative toroot
. This may be used multiple times to specify multiple files to exclude.exclude_match
This is just like
exclude_filename
but provides a regular expression pattern. Filenames matching the pattern (relative toroot
) are not gathered. This may be used multiple times to specify multiple patterns to exclude.prune_directory
While traversing, any directory matching the regular expression pattern will not be traversed further. This may be used multiple times to specify multiple directories to skip.
AUTHOR
Ricardo SIGNES 😏 <rjbs@semiotic.systems>
COPYRIGHT AND LICENSE
This software is copyright (c) 2022 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.
Module Install Instructions
To install Dist::Zilla, copy and paste the appropriate command in to your terminal.
cpanm Dist::Zilla
perl -MCPAN -e shell install Dist::Zilla
For more information on module installation, please visit the detailed CPAN module installation guide.