App::G...mReply(3pm)

💖 App::GitHooks::Plugin::Test::CustomReply 💖

okay bestie, so this is a page from the User Contributed Perl Documentation, section 3pm, and it's all about App::GitHooks::Plugin::Test::CustomReply. It's a test plugin, and the whole point of it is that you get to pick the return code yourself. no cap. that's the vibe. 🎀

---

✨ NAME ✨

App::GitHooks::Plugin::Test::CustomReply — a test plugin that lets you specify the return code. literally its whole job. 💅

---

🌸 DESCRIPTION 🌸

bestie… the description section is empty. not me pointing at a blank space like 👁️👄👁️. that's just how it is in the original, so we move. 🦋

---

⭐ SYNOPSIS ⭐

here's how you actually use it, copied exactly so you don't have to guess:

use App::GitHooks::Constants qw( :PLUGIN_RETURN_CODES );
use App::GitHooks::Plugin::Test::CustomReply;

# In .githooksrc.
# [Test::CustomReply]
# pre-commit = PLUGIN_RETURN_FAILED
# prepare-commit-msg = PLUGIN_RETURN_PASSED

# Run hooks calling the plugin.

so you drop that config in your .githooksrc, pick which return code each hook should spit out, and then run your hooks calling the plugin. easy. slay. 🔥

---

💜 VERSION 💜

Version 1.9.0. periodt. 👑

---

🫶 METHODS 🫶

🧚 get_file_pattern()

returns a pattern to filter which files this plugin should even bother analyzing. gatekeeping, but make it regex-y. ✨

my $file_pattern = App::GitHooks::Plugin::Test::CustomReply->get_file_pattern(
    app => $app,
);

🧚 get_file_check_description()

returns a description of the check that the plugin runs on your files — the one that gets shown to the user, if applicable, right alongside whether the plugin passed or failed. very main character of it. 💅

my $description = App::GitHooks::Plugin::Test::CustomReply->get_file_check_description();

---

🌈 SUPPORTED HOOKS 🌈

this plugin supports all the hooks defined in App::GitHooks::Hook::*, including file-level checks for the appropriate hooks. the whole roster, no skips:

• run_applypatch_msg
• run_commit_msg
• run_post_applypatch
• run_post_checkout
• run_post_commit
• run_post_merge
• run_post_receive
• run_post_rewrite
• run_post_update
• run_pre_applypatch
• run_pre_auto_gc
• run_pre_commit
• run_pre_commit_file
• run_pre_push
• run_pre_rebase
• run_pre_receive
• run_prepare_commit_msg
• run_update

eighteen hooks, all of them invited to the party. 🎉

---

😭 BUGS 😭

found a bug? want a feature? pls report it through the web interface at <https://github.com/guillaumeaubert/App-GitHooks/issues/new>. the maintainer gets notified, and then you automatically get notified of progress on your bug as changes are made. mutual notif situation. 🫶

---

💀 SUPPORT 💀

you can find the docs for this module with the perldoc command:

perldoc App::GitHooks::Plugin::Test::CustomReply

and you can also go looking for info at:

• GitHub's request tracker

<https://github.com/guillaumeaubert/App-GitHooks/issues>

• AnnoCPAN: Annotated CPAN documentation

<http://annocpan.org/dist/app-githooks>

• CPAN Ratings

<http://cpanratings.perl.org/d/app-githooks>

• MetaCPAN

<https://metacpan.org/release/App-GitHooks>

four whole places to lurk. iykyk. 🌸

---

👑 AUTHOR 👑

Guillaume Aubert <https://metacpan.org/author/AUBERTG>, "<aubertg at cpan.org>". the icon who made this. 🙈

---

🍓 COPYRIGHT & LICENSE 🍓

Copyright 2013-2017 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.

bestie the caps lock on those warranty disclaimers is not a drill — no promises, read the LICENSE file. 🫡

---

and that's the whole page, babe. 💖 this little writeup lives in perl v5.42.0, dated 2025-07-25, filed under App::G...mReply(3pm) in the User Contributed Perl Documentation. go forth and return-code your heart out. 💅✨🎀