/ 
Git-Hooks-3.6.0
River stage one • 5 direct dependents • 5 total dependents
/ Git::Hooks::CheckWhitespace

NAME

Git::Hooks::CheckWhitespace - Git::Hooks plugin for checking whitespace errors

VERSION

version 3.6.0

SYNOPSIS

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:

[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.

DESCRIPTION

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.

  • 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

NAME

CheckWhitespace - Git::Hooks plugin for checking whitespace errors

CONFIGURATION

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.

AUTHOR

Gustavo L. de M. Chaves <gnustavo@cpan.org>

COPYRIGHT AND LICENSE

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.