—

              
#!perl
# Note: This script is a CLI for Riap function /App/RegexpPatternUtils/match_with_regexp_pattern
# and generated automatically using Perinci::CmdLine::Gen version 0.501
use 5.010001;
use strict;
use warnings;
use Perinci::CmdLine::Any;
our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2022-05-08'; # DATE
our $DIST = 'App-RegexpPatternUtils'; # DIST
our $VERSION = '0.008'; # VERSION
my $cmdline = Perinci::CmdLine::Any->new(
    url => "/App/RegexpPatternUtils/match_with_regexp_pattern",
    program_name => "match-with-regexp-pattern",
    read_config => 0,
    read_env => 0,
    use_utf8 => 1,
);
$cmdline->run;
# ABSTRACT: Match a string against a Regexp::Pattern pattern
# PODNAME: match-with-regexp-pattern
__END__
HideShow 228 lines of Pod
=pod
=encoding UTF-8
=head1 NAME
match-with-regexp-pattern - Match a string against a Regexp::Pattern pattern
=head1 VERSION
This document describes version 0.008 of match-with-regexp-pattern (from Perl distribution App-RegexpPatternUtils), released on 2022-05-08.
=head1 SYNOPSIS
Usage:
% B<match-with-regexp-pattern> [B<--anchor>|B<--no-anchor>|B<--noanchor>] [B<--captures>|B<--no-captures>|B<--nocaptures>] [B<--format>=I<name>|B<--json>] [(B<--gen-arg> I<key>=I<s>)+] [B<--(no)naked-res>] [B<--page-result>[=I<program>]|B<--view-result>[=I<program>]] [B<--quiet>|B<-q>|B<--no-quiet>|B<--noquiet>] [B<--gen-args-json>=I<json>|(B<-A> I<key>=I<s>)+] -- E<lt>I<pattern>E<gt> E<lt>I<string>E<gt>
See examples in the L</EXAMPLES> section.
=head1 OPTIONS
C<*> marks required options.
=head2 Main options
=over
=item B<--anchor>
Generate an anchored version of the pattern.
=item B<--captures>
Return array of captures instead of just a boolean status.
=item B<--gen-arg>=I<s>%, B<-A>
Supply generator arguments.
If pattern is a dynamic pattern (generated on-demand) and the generator requires
some arguments, you can supply them here.
Each value is a name-value pair, use I<key=value> syntax. Can be specified multiple times.
=item B<--gen-args-json>=I<s>
Supply generator arguments (JSON-encoded).
See C<--gen-arg>.
=item B<--pattern>=I<s>*
Name of pattern, with module prefix but without the 'Regexp::Pattern'.
Can also be specified as the 1st command-line argument.
=item B<--quiet>, B<-q>
=item B<--string>=I<s>*
Can also be specified as the 2nd command-line argument.
=back
=head2 Output options
=over
=item B<--format>=I<s>
Choose output format, e.g. json, text.
Default value:
 undef
=item B<--json>
Set output format to json.
=item B<--naked-res>
When outputing as JSON, strip result envelope.
Default value:
 0
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
    [200,"OK",[1,2,3],{"func.extra"=>4}]
The reason is so you can get the status (1st element), status message (2nd
element) as well as result metadata/extra result (4th element) instead of just
the result (3rd element). However, sometimes you want just the result, e.g. when
you want to pipe the result for more post-processing. In this case you can use
`--naked-res` so you just get:
    [1,2,3]
=item B<--page-result>
Filter output through a pager.
=item B<--view-result>
View output using a viewer.
=back
=head2 Other options
=over
=item B<--help>, B<-h>, B<-?>
Display help message and exit.
=item B<--version>, B<-v>
Display program's version and exit.
=back
=head1 COMPLETION
This script has shell tab completion capability with support for several
shells.
=head2 bash
To activate bash completion for this script, put:
 complete -C match-with-regexp-pattern match-with-regexp-pattern
in your bash startup (e.g. F<~/.bashrc>). Your next shell session will then
recognize tab completion for the command. Or, you can also directly execute the
line above in your shell to activate immediately.
It is recommended, however, that you install modules using L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.
=head2 tcsh
To activate tcsh completion for this script, put:
 complete match-with-regexp-pattern 'p/*/`match-with-regexp-pattern`/'
in your tcsh startup (e.g. F<~/.tcshrc>). Your next shell session will then
recognize tab completion for the command. Or, you can also directly execute the
line above in your shell to activate immediately.
It is also recommended to install L<shcompgen> (see above).
=head2 other shells
For fish and zsh, install L<shcompgen> as described above.
=head1 EXAMPLES
A non-match:
 % match-with-regexp-pattern YouTube/video_id foo
 String DOES NOT match regexp pattern YouTube::video_id
A match:
 % match-with-regexp-pattern YouTube/video_id Yb4EGj4_uS0
 String matches regexp pattern YouTube::video_id
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/App-RegexpPatternUtils>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-App-RegexpPatternUtils>.
=head1 SEE ALSO
L<get-regexp-pattern-pattern>.
L<rpgrep>.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 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 L<Dist::Zilla>,
L<Dist::Zilla::PluginBundle::Author::PERLANCAR>,
L<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.
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2022, 2020, 2018, 2016 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.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-RegexpPatternUtils>
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.
=cut