/ 
App-GitHooks-Plugin-PerlCritic-v1.1.0
River stage zero No dependents
/ App::GitHooks::Plugin::PerlCritic

NAME

App::GitHooks::Plugin::PerlCritic - Verify that all changes and addition to the Perl files pass PerlCritic checks.

DESCRIPTION

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

Version 1.1.0

METHODS

get_file_pattern()

Return a pattern to filter the files this plugin should analyze.

my $file_pattern = App::GitHooks::Plugin::PerlCritic->get_file_pattern(
	app => $app,
);

get_file_check_description()

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();

run_pre_commit_file()

Code to execute for each file as part of the pre-commit hook.

my $success = App::GitHooks::Plugin::PerlCritic->run_pre_commit_file();

BUGS

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.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc App::GitHooks::Plugin::PerlCritic

You can also look for information at:

AUTHOR

Guillaume Aubert, <aubertg at cpan.org>.

COPYRIGHT & LICENSE

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.