/ 
App-PMUtils-0.745
River stage one • 1 direct dependent • 1 total dependent
/ App::pmgrep

NAME

App::pmgrep - Print lines from installed Perl module sources matching a pattern

VERSION

This document describes version 0.745 of App::pmgrep (from Perl distribution App-PMUtils), released on 2024-08-30.

FUNCTIONS

pmgrep

Usage:

pmgrep(%args) -> [$status_code, $reason, $payload, \%result_meta]

Print lines from installed Perl module sources matching a pattern.

This is a like the Unix command grep but instead of specifying filenames, you specify module names or prefixes. The utility will search module source files from Perl's @INC.

Examples:

# Find pre-increment in all Perl module files
% pmgrep '\+\+\$'

# Find some pattern in all Data::Sah::Coerce::* modules (note ** wildcard for recursing)
% pmgrep 'return ' Data::Sah::Coerce::**

This function is not exported.

Arguments ('*' denotes required arguments):

  • all => true

    Require all patterns to match, instead of just one.

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

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

  • count => true

    Supress normal output; instead 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 -v to 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.

  • files_with_matches => true

    Supress normal output; instead return filenames with matching lines; scanning for each file will stop on the first match.

  • files_without_match => true

    Supress normal output; instead return filenames without matching lines.

  • ignore_case => bool

    If set to true, will search case-insensitively.

  • invert_match => bool

    Invert the sense of matching.

  • line_number => true

    Show line number along with matches.

  • modules => perl::modnames

    If not specified, all installed Perl modules will be searched.

  • pattern => str

    Specify *string* to search for.

  • pm => bool (default: 1)

    Whether to include .pm files.

  • pmc => bool

    Whether to include .pmc files.

  • pod => bool

    Whether to include .pod files.

  • quiet => true

    Do not print matches, only return appropriate exit code.

  • recursive => true

    (No description)

  • regexps => array[str]

    Specify additional *regexp pattern* to search for.

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)

HOMEPAGE

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

SOURCE

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

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) 2024, 2023, 2022, 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014 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-PMUtils

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.