Git::Hooks::CheckWhitespace - Git::Hooks plugin for checking whitespace errors
version 3.6.0
As a Git::Hooks plugin you don't use this Perl module directly. Instead, you may configure it in a Git configuration file like this:
Git::Hooks
[githooks] # Enable the plugin plugin = CheckWhitespace # These users are exempt from all checks admin = joe molly
The first section enables the plugin and defines the users joe and molly as administrators, effectively exempting them from any restrictions the plugin may impose.
joe
molly
This Git::Hooks plugin hooks itself to the hooks below to check if the contents of files added to or modified in the repository have whitespace errors as detected by git diff --check command. If they don't, the commit/push is aborted.
git diff --check
pre-applypatch
pre-commit
update
pre-receive
ref-update
patchset-created
draft-published
To enable it you should add it to the githooks.plugin configuration option:
[githooks] plugin = CheckWhitespace
CheckWhitespace - Git::Hooks plugin for checking whitespace errors
There's no specific configuration for this plugin.
It can be disabled for specific references via the githooks.ref and githooks.noref options about which you can read in the Git::Hooks documentation.
githooks.ref
githooks.noref
Gustavo L. de M. Chaves <gnustavo@cpan.org>
This software is copyright (c) 2023 by CPQD <www.cpqd.com.br>.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Git::Hooks, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Git::Hooks
CPAN shell
perl -MCPAN -e shell install Git::Hooks
For more information on module installation, please visit the detailed CPAN module installation guide.