Scroll to navigation

Dist::Zilla::Plugin::GatherDir::Template(3pm) User Contributed Perl Documentation Dist::Zilla::Plugin::GatherDir::Template(3pm)

NAME

Dist::Zilla::Plugin::GatherDir::Template - gather all the files in a directory and use them as templates

VERSION

version 6.032

DESCRIPTION

This is a subclass of the GatherDir plugin. It works just like its parent class, except that each gathered file is processed through Text::Template.

The variables $plugin and $dist will be provided to the template, set to the GatherDir::Template plugin and the Dist::Zilla object, respectively.

It is meant to be used when minting dists with "dzil new", but could be used in building existing dists, too.

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

rename

Use this to rename files while they are being gathered. This is a list of key/value pairs, specified thus:

    [GatherDir::Template]
    rename.DISTNAME = $dist->name =~ s/...//r
    rename.DISTVER  = $dist->version

This example will replace the tokens "DISTNAME" and "DISTVER" with the expressions they are associated with. These expressions will be treated as though they were miniature Text::Template sections, and hence will receive the same variables that the file itself receives, i.e. $dist and $plugin.

AUTHOR

Ricardo SIGNES 😏 <cpan@semiotic.systems>

COPYRIGHT AND LICENSE

This software is copyright (c) 2024 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.

2024-05-26 perl v5.38.2