App::GitHooks::Plugin::PerlCritic - Verify that all changes and addition to the Perl files pass PerlCritic checks.
PerlCritic is a static source code analysis tool. This plugin calls PerlCritic and verifies that the staged modifications do not trigger any violations.
Note that if you stage half of a file for committing, this plugin will correctly only check for code violations in the staged half.
Version 1.1.0
Return a pattern to filter the files this plugin should analyze.
my $file_pattern = App::GitHooks::Plugin::PerlCritic->get_file_pattern( app => $app, );
Return a description of the check performed on files by the plugin and that will be displayed to the user, if applicable, along with an indication of the success or failure of the plugin.
my $description = App::GitHooks::Plugin::PerlCritic->get_file_check_description();
Code to execute for each file as part of the pre-commit hook.
my $success = App::GitHooks::Plugin::PerlCritic->run_pre_commit_file();
Please report any bugs or feature requests through the web interface at https://github.com/guillaumeaubert/App-GitHooks-Plugin-PerlCritic/issues/new. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
You can find documentation for this module with the perldoc command.
perldoc App::GitHooks::Plugin::PerlCritic
You can also look for information at:
GitHub's request tracker
https://github.com/guillaumeaubert/App-GitHooks-Plugin-PerlCritic/issues
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/app-githooks-plugin-perlcritic
CPAN Ratings
http://cpanratings.perl.org/d/app-githooks-plugin-perlcritic
MetaCPAN
https://metacpan.org/release/App-GitHooks-Plugin-PerlCritic
Guillaume Aubert, <aubertg at cpan.org>.
<aubertg at cpan.org>
Copyright 2013-2017 Guillaume Aubert.
This code is free software; you can redistribute it and/or modify it under the same terms as Perl 5 itself.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE file for more details.
To install App::GitHooks::Plugin::PerlCritic, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::GitHooks::Plugin::PerlCritic
CPAN shell
perl -MCPAN -e shell install App::GitHooks::Plugin::PerlCritic
For more information on module installation, please visit the detailed CPAN module installation guide.