- SEE ALSO
- COPYRIGHT AND LICENSE
Dist::Zilla::Plugin::GenerateFile::ShareDir - Create files in the build, based on a template located in a dist sharedir
In your dist.ini:
[GenerateFile::ShareDir] -dist = Dist::Zilla::PluginBundle::Author::ME -source_filename = my_data_template.txt -destination_filename = examples/my_data.txt key1 = value to pass to template key2 = another value to pass to template
Generates a file in your dist, indicated by
-destination_file, based on the Text::Template located in the
-dist's distribution sharedir. Any extra config values are passed along to the template, in addition to
I expect that usually the
-dist that contains the template will be either a plugin bundle, so you can generate a custom-tailored file in your dist, or a plugin that subclasses this one. (Otherwise, you can just as easily use [GatherDir::Template] or [GenerateFile] to generate the file directly, without needing a sharedir.)
All unrecognized keys/values will be passed to the template as is. Recognized options are:
The filename to generate in the distribution being built. Required.
The filename in the sharedir to use to generate the new file. Defaults to the same filename and path as
The encoding of the source file; will also be used for the encoding of the destination file. Defaults to UTF-8.
The target location of the generated file. When
build, the file is added to the distribution in the normal file gathering phase. When
root, the file is instead written to the source repository.
Only relevant when
-location = root. When
build (the default), the file is written on every build operation. When
release, it is only written after the distribution is released.
Bugs may be submitted through the RT bug tracker (or bug-Dist-Zilla-Plugin-GenerateFile-ShareDir@rt.cpan.org). I am also usually active on irc, as 'ether' at
[GatherDir::Template] - gather a file from the dist, and then pass it through a template
[GenerateFile] - generate a (possibly-templated) file purely based on data in dist.ini
Karen Etheridge <firstname.lastname@example.org>
Kent Fredric <email@example.com>
COPYRIGHT AND LICENSE
This software is copyright (c) 2013 by Karen Etheridge.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.