NAME

Pod::Weaver::Plugin::Data::Sah::Filter - Plugin to use when building Data::Sah::Filter::* or Data::Sah::FilterBundle::* distribution

VERSION

This document describes version 0.009 of Pod::Weaver::Plugin::Data::Sah::Filter (from Perl distribution Pod-Weaver-Plugin-Data-Sah-Filter), released on 2024-01-22.

SYNOPSIS

In your weaver.ini:

[-Data::Sah::Filter]

DESCRIPTION

This plugin is to be used when building Data::Sah::Filter::* or Data::Sah::FilterBundle::* distribution. Currently it does the following:

For each lib/Data/Sah/Filter/* module file:

  • Add a Synopsis section (if doesn't already exist) containing an example on how to use the Sah filter rule module in a Sah schema

For each lib/Data/Sah/FilterBundle/* module file:

  • Add list of filter rule modules at the beginning of Description section

CONFIGURATION

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Pod-Weaver-Plugin-Data-Sah-Filter.

SOURCE

Source repository is at https://github.com/perlancar/perl-Pod-Weaver-Plugin-Data-Sah-Filter.

SEE ALSO

Data::Sah::Filter

Dist::Zilla::Plugin::Data::Sah::Filter

Sah

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 -l

If 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) 2024, 2022, 2020 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=Pod-Weaver-Plugin-Data-Sah-Filter

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.