The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-GitHooks-Plugin-PerlCompile-v1.1.1
River stage zero No dependents
++
/ App::GitHooks::Plugin::PerlCompile

NAME

App::GitHooks::Plugin::PerlCompile - Verify that Perl files compile without errors.

DESCRIPTION

This plugin verifies that staged Perl files compile without errors before allowing the commit to be completed.

VERSION

Version 1.1.1

CONFIGURATION OPTIONS

This plugin supports the following options in the [PerlCompile] section of your .githooksrc file.

        [PerlCompile]
        lib_paths = ./lib, ./t/lib

lib_paths

This option gives an opportunity to include other paths to Perl libraries, and in particular paths that are local to the current repository. It allows testing that the Perl files compile without having to amend PERL5LIB to include the repository-specific libraries.

        lib_paths = ./lib, ./t/lib

METHODS

get_file_pattern()

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

        my $file_pattern = App::GitHooks::Plugin::PerlCompile->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::PerlCompile->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::PerlCompile->run_pre_commit_file();

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/guillaumeaubert/App-GitHooks-Plugin-PerlCompile/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::PerlCompile

You can also look for information at:

AUTHOR

Guillaume Aubert, <aubertg at cpan.org>.

COPYRIGHT & LICENSE

Copyright 2013-2016 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.