-
-
24 Dec 2021 00:05:56 UTC
- Distribution: App-PMUtils
- Module version: 0.738
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues (0)
- Testers (296 / 0 / 1)
- Kwalitee
Bus factor: 1- % Coverage
- License: perl_5
- Perl: v5.10.1
- Activity
24 month- Tools
- Download (47.97KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
- Dependencies
- App::ThisDist
- AppBase::Grep
- Browser::Open
- Complete::Module
- Config
- Cwd
- Data::Sah::Coerce::perl::To_array::From_str_or_array::expand_perl_modname_wildcard
- Data::Sah::Compiler::perl::TH::array
- Data::Sah::Compiler::perl::TH::bool
- Data::Sah::Compiler::perl::TH::code
- Data::Sah::Compiler::perl::TH::int
- Data::Sah::Compiler::perl::TH::re
- Data::Sah::Compiler::perl::TH::str
- Data::Sah::Filter::perl::Perl::normalize_perl_modname
- Data::Sah::Value::perl::Perl::these_mods
- Dist::Util
- ExtUtils::MakeMaker
- File::ShareDir
- File::Spec
- File::Temp
- File::Util::Tempdir
- File::Which
- HTTP::Tiny
- IO::Prompt::I18N
- IPC::System::Options
- JSON::MaybeXS
- Log::ger
- Module::Abstract
- Module::CoreList
- Module::CoreList::More
- Module::List
- Module::Load
- Module::Path::More
- Module::XSOrPP
- PERLANCAR::AppUtil::PerlStripper
- PERLANCAR::Module::List
- Perinci::CmdLine::Any
- Perinci::CmdLine::Lite
- Perinci::Sub::DepChecker
- Perinci::Sub::Util
- Perl::MinimumVersion
- Perl::Stripper
- Sah::Schema::perl::modname
- Sah::Schema::perl::modnames
- Sah::Schema::true
- SourceCode::LineCounter::Perl
- String::ShellQuote
- String::Wildcard::Bash
- experimental
- strict
- warnings
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
App::pmgrep - Print lines from installed Perl module sources matching a pattern
VERSION
This document describes version 0.738 of App::pmgrep (from Perl distribution App-PMUtils), released on 2021-12-03.
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")
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
-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.ignore_case => bool
invert_match => bool
Invert the sense of matching.
line_number => true
modules => perl::modnames
If not specified, all installed Perl modules will be searched.
pattern => str
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
recursive => 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)
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, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.
COPYRIGHT AND LICENSE
This software is copyright (c) 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.
Module Install Instructions
To install App::PMUtils, copy and paste the appropriate command in to your terminal.
cpanm App::PMUtils
perl -MCPAN -e shell install App::PMUtils
For more information on module installation, please visit the detailed CPAN module installation guide.