Skip to content

Feature: OR-ed plugins #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
boudekerk wants to merge 10 commits into
base: next
Choose a base branch
from
Open

Feature: OR-ed plugins #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e262178
Use warn/die instead of carp/croak
gnustavo May 13, 2023
78bc849
Allow plugins to be OR-ed.
Sep 19, 2023
a8bcd33
Update documentation
Sep 19, 2023
af39d5c
Example now shows it can be used in addition to the old behaviour
Sep 19, 2023
1adfe39
plugin is used elsewhere as variable, renaming for clarity
Sep 19, 2023
6e80c3c
No need for the grouping
Sep 19, 2023
4d0586e
Log how the different conditions were evaluated
Sep 20, 2023
f49bc97
Pass along the name of the plugin
Sep 27, 2023
4d73468
Only join array to avoid unnecessary whitespace
Sep 29, 2023
415490e
Merge branch 'next' into feature/OR-ed-plugins_76
boudekerk Oct 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions lib/Git/Hooks.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1278,6 +1278,13 @@ is useful if you want to enable a plugin globally and only disable it for some
repositories. You can even re-enable it later, if you want, by mentioning it
again without the prefix.

Plugins can be OR-ed by separating them with a pipe (C<|>) instead of a space.

[githooks]
plugin = CheckFile|CheckJira CheckWhitespace

In this case CheckWhitespace C<AND> either CheckFile C<OR> CheckJira has to match.

=head2 [DEPRECATED after v3.3.0] disable PLUGIN...

B<This option is deprecated.> Please, use the C<githooks.plugin> option with an
Expand Down
20 changes: 16 additions & 4 deletions lib/Git/Repository/Plugin/GitHooks.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ sub load_plugins {

my %plugins;

foreach my $plugin (map {split} $git->get_config(githooks => 'plugin')) {
foreach my $plugin (map {split /[\|\s]/} $git->get_config(githooks => 'plugin')) {
my ($negation, $prefix, $basename) = ($plugin =~ /^(\!?)((?:.+::)?)(.+)/);

if (exists $ENV{$basename} && ! $ENV{$basename}) {
Expand Down Expand Up @@ -803,10 +803,11 @@ sub fault {
my $colors = _githooks_colors($git);

my $msg;
my $prefix;

{
my $prefix = $info->{prefix} || caller;
my @context;
$prefix = $info->{prefix} || caller;
if (my $commit = $info->{commit}) {
$commit = $commit->commit
if ref $commit; # It's a Git::Repository::Log object
Expand Down Expand Up @@ -834,7 +835,7 @@ sub fault {
$msg .= "\n$colors->{details}$details$colors->{reset}\n\n";
}

push @{$git->{_plugin_githooks}{faults}}, $msg;
push @{$git->{_plugin_githooks}{faults}}, {msg => $msg, plugin => ($prefix) =~ /.*Git::Hooks::(\w+)/};

# Return true to allow for the idiom: <expression> or $git->fault(...) and <next|last|return>;
return 1;
Expand All @@ -853,7 +854,18 @@ sub get_faults {
$faults .= $colors->{header} . qx{$header} . "$colors->{reset}\n"; ## no critic (ProhibitBacktickOperators)
}

$faults .= join("\n\n", @{$git->{_plugin_githooks}{faults}});
my @conditions = split(" ", $git->get_config(githooks => 'plugin'));
map {s/(\||$)/(ok)$1/g} @conditions;

foreach my $fault (@{$git->{_plugin_githooks}{faults}}) {
map {s/($fault->{plugin})\(ok\)/$1(failed)/g} @conditions;
}

# If any parts of the condition don't have an 'OK', they've failed and we need to deny the commit
if (grep {!/\(ok\)/} @conditions) {
$faults .= join("\n\n", map {$_->{msg}} @{$git->{_plugin_githooks}{faults}});
$faults .= "\n\nOur configured plugins as they were evaluated:\n" . join(" ", @conditions) . "\n\n";
}

if ($git->{_plugin_githooks}{hookname} =~ /^commit-msg|pre-commit$/
&& ! $git->get_config_boolean(githooks => 'abort-commit')) {
Expand Down