21 May 2016 20:21:40 UTC
- Distribution: App-GitHooks-Plugin-BlockNOCOMMIT
- Module version: v1.1.1
- Source (raw)
- Browse (raw)
- How to Contribute
- Clone repository
- Issues (0)
- KwaliteeBus factor: 0
- 82.61% Coverage
- License: perl_5
- Perl: v5.10.0
- Activity24 month
- Download (14.46KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest versionAUBERTG Guillaume Aubert
- COPYRIGHT & LICENSE
App::GitHooks::Plugin::BlockNOCOMMIT - Prevent committing code with #NOCOMMIT mentions.
Sometimes you want to experiment with code, but you want to make sure that test code doesn't get committed by accident.
This plugin allows you to use
#NOCOMMITto indicate such code blocks, and will prevent you from committing those blocks.
# This is a test that will not work once deployed. # NOCOMMIT ...
Note that the following variations on the tag are correctly picked up:
# NO COMMIT
Return a pattern to filter the files this plugin should analyze.
my $file_pattern = App::GitHooks::Plugin::BlockNOCOMMIT->get_file_pattern( app => $app, );
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::BlockNOCOMMIT->get_file_check_description();
Code to execute for each file as part of the pre-commit hook.
my $success = App::GitHooks::Plugin::BlockNOCOMMIT->run_pre_commit_file();
Please report any bugs or feature requests through the web interface at https://github.com/guillaumeaubert/App-GitHooks-Plugin-BlockNoCommit/issues/new. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
You can find documentation for this module with the perldoc command.
You can also look for information at:
GitHub's request tracker
AnnoCPAN: Annotated CPAN documentation
<aubertg at cpan.org>.
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.
Module Install Instructions
To install App::GitHooks::Plugin::BlockNOCOMMIT, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install App::GitHooks::Plugin::BlockNOCOMMIT
For more information on module installation, please visit the detailed CPAN module installation guide.