The Perl Advent Calendar needs more articles for 2022. Submit your idea today!

NAME

Data::Sah::Filter::perl::Str::remove_comment - Remove comment

VERSION

This document describes version 0.015 of Data::Sah::Filter::perl::Str::remove_comment (from Perl distribution Data-Sah-Filter), released on 2022-10-18.

SYNOPSIS

Using in Sah schema's prefilters (or postfilters) clause

 ["str","prefilters",[["Str::remove_comment"]]]

Using with Data::Sah:

 use Data::Sah qw(gen_validator);
 
 my $schema = ["str","prefilters",[["Str::remove_comment"]]];
 my $validator = gen_validator($schema);
 if ($validator->($some_data)) { print 'Valid!' }

Using with Data::Sah:Filter directly:

 use Data::Sah::Filter qw(gen_filter);

 my $filter = gen_filter([["Str::remove_comment"]]);
 my $filtered_value = $filter->($some_data);

Sample data and filtering results

 "foo" # valid, unchanged
 "foo # comment" # valid, becomes "foo"
 "foo # comment" # filtered with args {style=>"cpp"}, valid, unchanged
 "foo // comment" # filtered with args {style=>"cpp"}, valid, becomes "foo"

HOMEPAGE

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

SOURCE

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

SEE ALSO

Other Data::Sah::Filter::perl::Str::remove_* modules.

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) 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=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.