/ 
AppBase-Grep-0.001
River stage two • 12 direct dependents • 13 total dependents
/ AppBase::Grep

NAME

AppBase::Grep - A base for grep-like CLI utilities

VERSION

This document describes version 0.001 of AppBase::Grep (from Perl distribution AppBase-Grep), released on 2018-01-26.

FUNCTIONS

grep

Usage:

grep(%args) -> [status, msg, 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 -i, -v, highlighting, and so on.

This function is not exported.

Arguments ('*' denotes required arguments):

  • color => str (default: "auto")

  • count => true

    Supress normal output, return a count of matching lines.

  • ignore_case => bool

  • invert_match => bool

    Invert the sense of matching.

  • pattern* => re

  • quiet => true

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/perlancar/perl-AppBase-Grep.

BUGS

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2018 by 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.