1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
|
NAME
Perinci::Sub::Normalize - Normalize Rinci function metadata
VERSION
This document describes version 0.207 of Perinci::Sub::Normalize (from
Perl distribution Perinci-Sub-Normalize), released on 2022-12-19.
SYNOPSIS
use Perinci::Sub::Normalize qw(normalize_function_metadata);
my $nmeta = normalize_function_metadata($meta);
FUNCTIONS
normalize_function_metadata($meta[ , \%opts ]) => HASH
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.
HOMEPAGE
Please visit the project's homepage at
<https://metacpan.org/release/Perinci-Sub-Normalize>.
SOURCE
Source repository is at
<https://github.com/perlancar/perl-Perinci-Sub-Normalize>.
SEE ALSO
Rinci::function
AUTHOR
perlancar <perlancar@cpan.org>
CONTRIBUTOR
Steven Haryanto <stevenharyanto@gmail.com>
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) 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.
BUGS
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.
|