Code::T...recommit(3)

💅 NAME 💅

Okay so bestie, welcome to Code::TidyAll::Git::Precommit — it's a Git pre-commit hook that literally will not let you commit unless every file is tidyall'd. No cap. The actual man page title is Code::T...recommit(3) (yes, they truncated it, iconic of them), and this is the User Contributed Perl Documentation version.

✨ VERSION ✨

version 0.84 🎀

🦋 SYNOPSIS 🦋

So like, in .git/hooks/pre-commit you drop this:

#!/usr/bin/env perl
use strict;
use warnings;

use Code::TidyAll::Git::Precommit;
Code::TidyAll::Git::Precommit->check();

That's it. That's the whole vibe check. 🫶

---

🌸 DESCRIPTION 🌸

This module implements a Git pre-commit hook (link in the original: <http://git-scm.com/book/en/Customizing-Git-Git-Hooks>) that checks if all files are tidied and valid according to tidyall, and rejects the commit if not. And listen — files/commits are never modified by this hook. It's a bouncer, not a stylist. 💅

Also see Code::TidyAll::Git::Prereceive, which validates pushes to a shared repo. Different vibe, same energy.

Your tidyall configuration file (tidyall.ini or .tidyallrc) must be checked into git in the repo root directory — i.e. right next to the .git directory. Like, literally next to it. Don't make it weird. 🎀

By default, the hook will stash any changes not in the index beforehand, and restore them afterwards, via:

git stash save --keep-index --include-untracked
....
git stash pop

Which means: if the configuration file has uncommitted changes that are not in the index, they will not affect the tidyall run. Sneaky little detail but we love a consistent test environment. ✨

---

👑 METHODS 👑

This class provides one method, and honestly one is enough:

Code::TidyAll::Git::Precommit->check(%params)

Checks that all files being added or modified in this commit are tidied and valid according to tidyall. If not, then the entire commit is rejected and the reason(s) are output to the client. Like, for example:

% git commit -m "fixups" CHI.pm CHI/Driver.pm
2 files did not pass tidyall check
lib/CHI.pm: *** 'PerlTidy': needs tidying
lib/CHI/Driver.pm: *** 'PerlCritic': Code before strictures are enabled
  at /tmp/Code-TidyAll-0e6K/Driver.pm line 2
  [TestingAndDebugging::RequireUseStrict]

Read it and weep, then go tidy your files. 😭

In an emergency the hook can be bypassed by passing --no-verify to commit:

% git commit --no-verify ...

…or you can just move .git/hooks/pre-commit out of the way temporarily. Do with that information what you will. 🙈

This class passes mode = "commit" by default to tidyall; see modes.

Key/value parameters, bestie, here we go:

• conf_name — A conf file name to search for instead of the defaults.
• git_path — Path to git to use in commands, e.g. '/usr/bin/git' or '/usr/local/bin/git'. By default, it just uses 'git', which will search the user's "PATH".
• no_stash — Don't attempt to stash changes not in the index. Heads up though: this means the hook will process files that are not going to be committed. 🫣
• tidyall_class — Subclass to use instead of Code::TidyAll.
• tidyall_options — A hashref of options to pass to the Code::TidyAll constructor.

---

🧚 USING AND (NOT) ENFORCING THIS HOOK 🧚

Okay this is the part where I have to be real with you: this hook must be placed manually in each copy of the repo — there is no way to automatically distribute or enforce it. It's giving main character who refuses to be managed. However, you can make things easier on yourself or your developers as follows:

• Create a directory called git/hooks at the top of your repo (note: no dot prefix, we're being quirky here):

mkdir -p git/hooks

• Commit your pre-commit script in git/hooks/pre-commit containing:

#!/usr/bin/env perl

use strict;
use warnings;

use Code::TidyAll::Git::Precommit;
Code::TidyAll::Git::Precommit->check();

• Add a setup script in git/setup.sh containing:

#!/bin/bash
chmod +x git/hooks/pre-commit
cd .git/hooks
ln -s ../../git/hooks/pre-commit

• Run "git/setup.sh" (or tell your developers to run it) once for each new clone of the repo. Yes, once per clone. I know. I know. 😭

See this Stack Overflow question for more information on pre-commit hooks and the impossibility of enforcing their use. (The original page references it; can't link it here, but you know the one.) 💀

See also Code::TidyAll::Git::Prereceive, which enforces tidyall on pushes to a remote shared repository — that's the one that can actually be enforced, slay. 👑

---

🍓 SUPPORT 🍓

Bugs may be submitted at <https://github.com/houseabsolute/perl-code-tidyall/issues>. Please be nice to the maintainers, they're doing their best. 💖

⭐ SOURCE ⭐

The source code repository for Code-TidyAll can be found at <https://github.com/houseabsolute/perl-code-tidyall>.

🌈 AUTHORS 🌈

• Jonathan Swartz <swartz@pobox.com>
• Dave Rolsky <autarch@urth.org>

Legends, both of them. 🫶

💜 COPYRIGHT AND LICENSE 💜

This software is copyright (c) 2011 - 2023 by Jonathan Swartz.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

The full text of the license can be found in the LICENSE file included with this distribution.

---

And that's the whole page, bestie — brought to you by perl v5.42.0, dated 2024-03-08, from the Code::T...recommit(3) manual. Go forth and commit tidy files only. 💅✨🎀