NAME
Dist::Zilla::Plugin::InsertModulesList - Insert a POD containing a list of modules in the distribution
VERSION
This document describes version 0.031 of Dist::Zilla::Plugin::InsertModulesList (from Perl distribution Dist-Zilla-Plugin-InsertModulesList), released on 2023-03-02.
SYNOPSIS
In dist.ini:
[InsertModulesList]In lib/Foo.pm:
...
=head1 DESCRIPTION
This distribution contains the following modules:
#INSERT_MODULES_LIST
...After build, lib/Foo.pm will contain:
...
=head1 DESCRIPTION
This distribution contains the following modules:
=over
=item 1. L<Foo>
=item 2. L<Foo::Bar>
=item 3. L<Foo::Baz>
...
=back
...DESCRIPTION
This plugin finds # INSERT_MODULES_LIST directive in your POD/code and replace it with a POD containing list of modules in the distribution.
To exclude a module from the generated list, use:
# INSERT_MODULES_LIST -Foo::Bar -Baz ...To exclude modules matching a regex, use:
# INSERT_MODULES_LIST -/^Foo::Bar::(Helper|Util)/To only include modules matching a regex, use:
Below are the included plugins in this distribution:
# INSERT_MODULES_LIST /^Foo::Plugin::/Excludes and includes can be combined.
CONFIGURATION
ordered
Bool. Can be set to true to always generate an ordered list, or false to always generate an unordered list. If unset, will use unordered list for 6 or less items and ordered list otherwise.
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/Dist-Zilla-Plugin-InsertModulesList.
SOURCE
Source repository is at https://github.com/perlancar/perl-Dist-Zilla-Plugin-InsertModulesList.
SEE ALSO
Dist::Zilla::Plugin::InsertExecsList
AUTHOR
perlancar <perlancar@cpan.org>
CONTRIBUTING
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -lIf you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
COPYRIGHT AND LICENSE
This software is copyright (c) 2023, 2019, 2015 by perlancar <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.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-InsertModulesList
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.