NAME

match-with-regexp-pattern - Match a string against a Regexp::Pattern pattern

VERSION

This document describes version 0.008 of match-with-regexp-pattern (from Perl distribution App-RegexpPatternUtils), released on 2022-05-08.

SYNOPSIS

Usage:

% match-with-regexp-pattern [--anchor|--no-anchor|--noanchor] [--captures|--no-captures|--nocaptures] [--format=name|--json] [(--gen-arg key=s)+] [--(no)naked-res] [--page-result[=program]|--view-result[=program]] [--quiet|-q|--no-quiet|--noquiet] [--gen-args-json=json|(-A key=s)+] -- <pattern> <string>

See examples in the "EXAMPLES" section.

OPTIONS

* marks required options.

Main options

--anchor

Generate an anchored version of the pattern.

--captures

Return array of captures instead of just a boolean status.

--gen-arg=s%, -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 key=value syntax. Can be specified multiple times.

--gen-args-json=s

Supply generator arguments (JSON-encoded).

See --gen-arg.

--pattern=s*

Name of pattern, with module prefix but without the 'Regexp::Pattern'.

Can also be specified as the 1st command-line argument.

--quiet, -q

--string=s*

Can also be specified as the 2nd command-line argument.

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

undef

--json

Set output format to json.

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

--page-result

Filter output through a pager.

--view-result

View output using a viewer.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

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. ~/.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 cpanm-shcompgen which can activate shell completion for scripts immediately.

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. ~/.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 shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

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

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-RegexpPatternUtils.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-RegexpPatternUtils.

SEE ALSO

get-regexp-pattern-pattern.

rpgrep.

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, 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.

BUGS

Please report any bugs or feature requests on the bugtracker website 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.

cpanm App::RegexpPatternUtils

perl -MCPAN -e shell
install App::RegexpPatternUtils