DOKK / manpages / debian 12 / libperinci-sub-normalize-perl / Perinci::Sub::Normalize.3pm.en
Perinci::Sub::Normalize(3pm) User Contributed Perl Documentation Perinci::Sub::Normalize(3pm)

Perinci::Sub::Normalize - Normalize Rinci function metadata

This document describes version 0.207 of Perinci::Sub::Normalize (from Perl distribution Perinci-Sub-Normalize), released on 2022-12-19.

 use Perinci::Sub::Normalize qw(normalize_function_metadata);
 my $nmeta = normalize_function_metadata($meta);

Normalize and check Rinci function metadata $meta. Return normalized metadata, which is a shallow copy of $meta. Die on error.

Available options:

  • allow_unknown_properties => BOOL (default: 0)

    If set to true, will die if there are unknown properties.

  • normalize_sah_schemas => BOOL (default: 1)

    By default, Sah schemas e.g. in "result/schema" or "args/*/schema" property is normalized using Data::Sah's "normalize_schema". Set this to 0 if you don't want this.

  • remove_internal_properties => BOOL (default: 0)

    If set to 1, all properties and attributes starting with underscore ("_") with will be stripped. According to DefHash specification, they are ignored and usually contain notes/comments/extra information.

Please visit the project's homepage at <https://metacpan.org/release/Perinci-Sub-Normalize>.

Source repository is at <https://github.com/perlancar/perl-Perinci-Sub-Normalize>.

Rinci::function

perlancar <perlancar@cpan.org>

Steven Haryanto <stevenharyanto@gmail.com>

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.

This software is copyright (c) 2022, 2018, 2016, 2015, 2014 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.

Please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-Sub-Normalize>

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.

2022-12-30 perl v5.36.0