1Dist::Zilla::Plugin::GeUnseerratCeoFnitlrei(b3u)ted PerlDiDsotc:u:mZeinltlaat:i:oPnlugin::GenerateFile(3)
2
3
4

NAME

6       Dist::Zilla::Plugin::GenerateFile - build a custom file from only the
7       plugin configuration
8

VERSION

10       version 6.014
11

SYNOPSIS

13       In your dist.ini:
14
15         [GenerateFile]
16         filename    = todo/{{ $dist->name }}-master-plan.txt
17         name_is_template = 1
18         content_is_template = 1
19         content = # Outlines the plan for world domination by {{$dist->name}}
20         content =
21         content = Item 1: Think of an idea!
22         content = Item 2: ?
23         content = Item 3: Profit!
24

DESCRIPTION

26       This plugin adds a file to the distribution.
27
28       You can specify the content, as a sequence of lines, in your
29       configuration.  The specified filename and content might be literals or
30       might be Text::Template templates.
31
32   Templating of the content
33       If you provide "content_is_template" (or "is_template") parameter of
34       "1", the content will be run through Text::Template.  The variables
35       $plugin and $dist will be provided, set to the [GenerateFile] plugin
36       and the Dist::Zilla object respectively.
37
38       If you provide a "name_is_template" parameter of "1", the filename will
39       be run through Text::Template.  The variables $plugin and $dist will be
40       provided, set to the [GenerateFile] plugin and the Dist::Zilla object
41       respectively.
42

ATTRIBUTES

44   filename
45       This attribute names the file you want to generate.  It is required.
46
47   content
48       The "content" attribute is an arrayref of lines that will be joined
49       together with newlines to form the file content.
50
51   content_is_template, is_template
52       This attribute is a bool indicating whether or not the content should
53       be treated as a Text::Template template.  By default, it is false.
54
55   name_is_template
56       This attribute is a bool indicating whether or not the filename should
57       be treated as a Text::Template template.  By default, it is false.
58

AUTHOR

60       Ricardo SIGNES 😏 <rjbs@cpan.org>
61

63       This software is copyright (c) 2020 by Ricardo SIGNES.
64
65       This is free software; you can redistribute it and/or modify it under
66       the same terms as the Perl 5 programming language system itself.
67
68
69
70perl v5.30.1                      2020-03-0D3ist::Zilla::Plugin::GenerateFile(3)
Impressum