/ 
App-GitHooks-Plugin-PreventTrailingWhitespace-v1.0.0
River stage zero No dependents
/ App::GitHooks::Plugin::PreventTrailingWhitespace

NAME

App::GitHooks::Plugin::PreventTrailingWhitespace - Prevent trailing whitespace from being committed.

DESCRIPTION

Prevent pesky trailing whitespace from being committed.

VERSION

Version 1.0.0

METHODS

get_file_pattern()

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

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

run_pre_commit_file()

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

This is where the magic happens.

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

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/barwin/App-GitHooks-Plugin-PreventTrailingWhitespace/issues/new.

SUPPORT

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

perldoc App::GitHooks::Plugin::PreventTrailingWhitespace

You can also look for information at:

AUTHOR

Ben Arwin, <barwin at cpan.org>.

ACKNOWLEDGEMENTS

For guidance on this module and for creating App::GitHooks, big thanks to:

Guillaume Aubert, <aubertg at cpan.org>.

COPYRIGHT & LICENSE

Copyright 2013-2014 Ben Arwin.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as published by the Free Software Foundation.

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 GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/