- COPYRIGHT AND LICENSE
AppBase::Grep - A base for grep-like CLI utilities
This document describes version 0.008 of AppBase::Grep (from Perl distribution AppBase-Grep), released on 2021-06-09.
perlancar (on pc-office) <firstname.lastname@example.org>
grep(%args) -> [$status_code, $reason, $payload, \%result_meta]
A base for grep-like CLI utilities.
This routine provides a base for grep-like CLI utilities. It accepts coderef as source of lines, which in the actual utilities can be from files or other sources. It provides common options like
-c, color highlighting, and so on.
Why? For grepping lines from files or stdin, abgrep is no match for the standard grep (or its many alternatives): it's orders of magnitude slower and currently has fewer options. But AppBase::Grep is a quick way to create grep-like utilities that grep from a custom sources but have common/standard grep features.
Compared to the standard grep, AppBase::Grep also has these unique features:
--alloption to match all patterns instead of just one;
COLORenvironment variable to set
This function is not exported.
Arguments ('*' denotes required arguments):
all => true
Require all patterns to match, instead of just one.
color => str (default: "auto")
count => true
Supress normal output, return a count of matching lines.
dash_prefix_inverts => bool
When given pattern that starts with dash "-FOO", make it to mean "^(?!.*FOO)".
This is a convenient way to search for lines that do not match a pattern. Instead of using
-vto invert the meaning of all patterns, this option allows you to invert individual pattern using the dash prefix, which is also used by Google search and a few other search engines.
ignore_case => bool
invert_match => bool
Invert the sense of matching.
line_number => true
pattern => str
quiet => true
regexps => array[str]
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
If set, will disable color. Takes precedence over "COLOR" but not
Boolean. If set to true, will set default
always instead of
auto. If set to false, will set default
never instead of
auto. This behavior is not in GNU grep.
String. Will search color themes in
AppBase::Grep::ColorTheme::* as well as
Please visit the project's homepage at https://metacpan.org/release/AppBase-Grep.
Source repository is at https://github.com/perlancar/perl-AppBase-Grep.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=AppBase-Grep
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.
This software is copyright (c) 2021, 2020, 2018 by email@example.com.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.