/ 
App-wcgrep-0.002
River stage one • 1 direct dependent • 1 total dependent
/ wcgrep

NAME

wcgrep - Print lines matching a wildcard pattern

VERSION

This document describes version 0.002 of wcgrep (from Perl distribution App-wcgrep), released on 2023-11-17.

SYNOPSIS

wcgrep --help (or -h, -?)

wcgrep --version (or -v)

wcgrep [--color=str] [--count|-c] [--debug|--log-level=level|--quiet|--trace|--verbose] [--dereference-recursive|-R] [(--file=filename)+|--files-json=json] [--format=name|--json] [--ignore-case|-i|--no-ignore-case|--noignore-case] [--invert-match|-v|--no-invert-match|--noinvert-match] [--line-number|-n] [--(no)naked-res] [--page-result[=program]|--view-result[=program]] [--quiet-arg|-q|--silent] [--recursive|-r] -- <pattern> [file] ...

See examples in the "EXAMPLES" section.

DESCRIPTION

This is another grep-like utility that is based on AppBase::Grep, mainly for demoing and testing the module. It accepts bash wildcard pattern instead of regular expression.

OPTIONS

* marks required options.

Main options

--dereference-recursive, -R

Read all files under each directory, recursively, following all symbolic links, unlike -r.

--file=s@

(No description)

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

Can be specified multiple times.

--files-json=s

See --file.

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

--pattern=s*

Specify *wildcard pattern* to search for.

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

--recursive, -r

Read all files under each directory, recursively, following symbolic links only if they are on the command line.

General output control options

--color=s

Specify when to show color (never, always, or auto/when interactive).

Default value:

"auto"

Valid values:

["never","always","auto"]
--count, -c

Supress normal output, return a count of matching lines.

--quiet-arg, --silent, -q

Do not print matches, only return appropriate exit code.

Logging options

--debug

Shortcut for --log-level=debug.

--log-level=s

Set log level.

By default, these log levels are available (in order of increasing level of importance, from least important to most): trace, debug, info, warn/warning, error, fatal. By default, the level is usually set to warn, which means that log statements with level info and less important levels will not be shown. To increase verbosity, choose info, debug, or trace.

For more details on log level and logging, as well as how new logging levels can be defined or existing ones modified, see Log::ger.

--quiet

Shortcut for --log-level=error.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

Matching control options

--ignore-case, -i

If set to true, will search case-insensitively.

--invert-match, -v

Invert the sense of matching.

Output line prefix control options

--line-number, -n

Show line number along with matches.

Output options

--format=s

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

Default value:

undef

Output can be displayed in multiple formats, and a suitable default format is chosen depending on the application and/or whether output destination is interactive terminal (i.e. whether output is piped). This option specifically chooses an output format.

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

This option will pipe the output to a specified pager program. If pager program is not specified, a suitable default e.g. less is chosen.

--view-result

View output using a viewer.

This option will first save the output to a temporary file, then open a viewer program to view the temporary file. If a viewer program is not chosen, a suitable default, e.g. the browser, is chosen.

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

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 wcgrep 'p/*/`wcgrep`/'

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

Show lines that contain foo and bar, in that order

% wcgrep 'foo*bar' file1 file2

HOMEPAGE

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

SOURCE

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

SEE ALSO

abgrep.

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) 2023 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-wcgrep

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.