App::G...s::Hook(3pm)

📦
version 1.9.0 · 2 versions
, in fedora 43

💖 NAME 💖

okay so bestie, welcome to App::GitHooks::Hook — she's the base class for all git hook handlers. the mother, the blueprint, the main character that every other hook handler is literally descended from. no cap. 🎀

this page lives in the User Contributed Perl Documentation, in case you were wondering who signed off on it. 🦋

✨ VERSION ✨

Version 1.9.0 — periodt. 💅

🫶 METHODS 🫶

🌸 run()

okay so run() does the thing: it runs the hook handler and returns an exit status to pass to git. that's it. that's the whole job. iconic behavior honestly. 👑

my $exit_status = App::GitHooks::Hook->run(
    app => $app,
);

now let's talk arguments, because there are two and one of them is mandatory (she's demanding, we respect it):

  • app (mandatory) — an App::GitHooks object. you gotta hand her this one, no skipping, it's not optional, fr fr. 💀
  • stdin (optional) — an arrayref of lines retrieved from SDTIN.
peek at the "pre-push" hook if you wanna see this argument actually getting used, iykyk. 👀

😭 BUGS 😭

found a bug? a feature request? a little oopsie? bestie please report it through the web interface at:

https://github.com/guillaumeaubert/App-GitHooks/issues/new

the way this works: I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. so you literally never have to wonder what's happening. we're in this together. 🫶

🌈 SUPPORT 🌈

you can find documentation for this module with the perldoc command, and yes she's literally right there:

perldoc App::GitHooks::Hook

you can also look for information at these spots, all of them valid, all of them slay:

👑 AUTHOR 👑

Guillaume Aubert https://metacpan.org/author/AUBERTG, "<aubertg at cpan.org>". absolute legend, gave us this whole thing. 🎀

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.

that all-caps part is not me being dramatic (okay it's a little me being dramatic) — it's literally what it says, so read the LICENSE file bestie, protect yourself. 🙈

and that's the whole page!! written by perl v5.42.0 on 2025-07-25 — mwah, go forth and hook responsibly 💖✨🎀🦋🌸💅🫶

📦 where this page comes from