NAME App::PerlCriticUtils - Command-line utilities related to Perl::Critic VERSION This document describes version 0.004 of App::PerlCriticUtils (from Perl distribution App-PerlCriticUtils), released on 2021-08-27. SYNOPSIS This distribution provides the following command-line utilities related to Perl::Critic: * pcpcat * pcpdoc * pcpless * pcplist * pcpman * pcppath FUNCTIONS pcpcat Usage: pcpcat(%args) -> [$status_code, $reason, $payload, \%result_meta] Print Perl::Critic policy module source code. Examples: * Example #1: pcpcat(policies => ["Variables/ProhibitMatchVars"]); This function is not exported. Arguments ('*' denotes required arguments): * policies* => *array[perl::modname]* 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) pcpdoc Usage: pcpdoc(%args) -> [$status_code, $reason, $payload, \%result_meta] Show documentation of Perl::Critic policy module. Examples: * Example #1: pcpdoc(policy => "Variables/ProhibitMatchVars"); This function is not exported. Arguments ('*' denotes required arguments): * policy* => *perl::modname* 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) pcpless Usage: pcpless(%args) -> [$status_code, $reason, $payload, \%result_meta] Show Perl::Critic policy module source code with `less`. Examples: * Example #1: pcpless(policy => "Variables/ProhibitMatchVars"); This function is not exported. Arguments ('*' denotes required arguments): * policy* => *perl::modname* 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) pcplist Usage: pcplist(%args) -> [$status_code, $reason, $payload, \%result_meta] List installed Perl::Critic policy modules. Examples: * List installed policies: pcplist(); * List installed policies (show details): pcplist(detail => 1); This function is not exported. Arguments ('*' denotes required arguments): * detail => *bool* 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) pcpman Usage: pcpman(%args) -> [$status_code, $reason, $payload, \%result_meta] Show manpage of Perl::Critic policy module. Examples: * Example #1: pcpman(policy => "Variables/ProhibitMatchVars"); This function is not exported. Arguments ('*' denotes required arguments): * policy* => *perl::modname* 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) pcppath Usage: pcppath(%args) -> [$status_code, $reason, $payload, \%result_meta] Get path to locally installed Perl::Critic policy module. Examples: * Example #1: pcppath(policies => ["Variables/ProhibitMatchVars"]); This function is not exported. Arguments ('*' denotes required arguments): * policies* => *array[perl::modname]* 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 . SOURCE Source repository is at . AUTHOR perlancar 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, 2018, 2017 by perlancar . 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 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.