The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Dist::Zilla::Plugin::RenderTemplate - Render template into your scripts/modules during build

VERSION

This document describes version 0.01 of Dist::Zilla::Plugin::RenderTemplate (from Perl distribution Dist-Zilla-Plugin-RenderTemplate), released on 2015-03-22.

SYNOPSIS

In dist.ini:

 [RenderTemplate]

In /some/path/template.txt:

 Hello, {{ username }}!

In lib/Foo.pm:

 ...

 # RENDER_TEMPLATE: file=>"/some/path/template.txt", context=>{username=>"ujang"}

 ...

After build, lib/Foo.pm will become:

 ...

 Hello, ujang!

 ...

DESCRIPTION

This plugin finds #RENDER_TEMPLATE: ... directive in your scripts/modules, renders the specified template (currently using DTL::Fast), and replaces the directive with the rendered result.

The ... part is parsed as Perl using eval and should produce a hash of arguments. Known arguments:

  • file => str

    Specify the path to template file. Either specify this, or dist and dist_file.

  • dist => str

    Specify that template file is to be retrieved from per-dist shared dir (see File::ShareDir). This argument specify the dist name. You also have to specify dist_file. The path to template will be retrieved using dist_file($dist, $dist_file).

  • dist_file => str

    See dist argument.

  • context => hashref

    Specify context (variables).

SEE ALSO

DTL::Fast

Dist::Zilla::Plugin::InsertBlock

Dist::Zilla::Plugin::InsertExample - which basically insert whole files instead of just a block of text from a file

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Dist-Zilla-Plugin-RenderTemplate.

SOURCE

Source repository is at https://github.com/perlancar/perl-Dist-Zilla-Plugin-RenderTemplate.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-RenderTemplate

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.