TIDY_CHANGELOG(1p)

💖 TIDY_CHANGELOG 💖

okay bestie, so this is tidy_changelog — it lives in section 1p of the User Contributed Perl Documentation, and it's the command-line glow-up tool for CPAN::Changes. yes, the changelog whisperer. let's go 🎀

---

✨ SYNOPSIS ✨

$ tidy_changelog Changelog

like... that's it. that's the whole vibe. 💅

---

🌸 DESCRIPTION 🌸

So what it does is: it takes a changelog file, parses it with CPAN::Changes, and prints out the resulting output. slay. ✨

And the little party trick? If you don't give it a file, it goes looking around the current directory for one single file whose name starts with change (case-insensitive, she's not picky 💅) and if it finds exactly one, she just assumes that's the changelog. main character energy tbh. 👑

---

🦋 ARGUMENTS 🦋

ngl the flags are where it gets fun. one bullet each, no skipping, we're doing all of them:

• --next — if you pass this, she assumes there's a placeholder header chilling there for an upcoming next release. where does she find that placeholder token? you tell her with --token. 🎀
• --token — this is the regular expression she uses to detect the token for that upcoming release, but only if --next is in play. don't give it to her? no worries, it defaults to \{\{\$NEXT\}\}. 💜
• --headers — if you pass this, she only prints the release header lines. none of the actual changes. just the vibes, not the lore. 🙈
• --reverse — prints the releases in reverse order, so from the oldest to the latest. yes bestie, backwards. chronological girlies rise. 🔥
• --check — she doesn't print anything, she just checks whether the changelog is formatted properly, using the changes_file_ok function from Test::CPAN::Changes. vibe check, but make it a test suite. ⭐
• --help — this help. the one you're reading. hi. 👋

lowkey if you're just here for --check, that's the one that tells you if your changelog passes. no cap.

---

and that's the whole page, bestie!! 🫶 this icon of a manual page ships with perl v5.40.1, dated 2025-04-20 — so go forth, tidy those changelogs, and remember: the changelog is the receipt of your chaos. periodt. 💖✨🎀🦋🌸💅