panache-debug-format(1)

📦
version 3.16.0 · 2 versions
, in nixpkgs unstable

💅 NAME 💅

ok so panache-debug-format — your little bestie that runs the parser + formatter checks and then spills all the diagnostics. that's literally the whole job. ✨ (this one lives in the General Commands Manual, section 1, iykyk)

🦋 SYNOPSIS 🦋

panache debug format [--checks] [--json] [--report] [--dump-dir]
[--dump-passes] [--force-exclude] [-h|--help] [-V|--version] [FILES]

🌸 DESCRIPTION 🌸

Run parser+formatter checks and emit diagnostics. yes queen, that's it, that's the vibe — it parses, it formats, it checks, and then it hands you the receipts. 🧾💖

✨ OPTIONS ✨

  • --checks <CHECKS> [default: all] — picks which checks you actually wanna run. and the possible values are, drumroll please 🥁:
    • idempotency
    • losslessness
    • all
  • --json — emits JSON output, for when you're feeding it to machine-readable tooling. robots deserve slay output too 🤖✨
  • --report — emits a Markdown report instead, which is chef's kiss for pasting into issue descriptions. 📝💅
  • --dump-dir <DIR> — the directory where failing artifacts get written. think of it as the little collection bin for the mess 🗂️
  • --dump-passes — writes input/parse/format pass artifacts to --dump-dir for every file. not just the failing ones, bestie, every single one 👀
  • --force-exclude — makes the exclude patterns from your configuration apply even to files you passed explicitly on the command line. ok so by default, explicitly-named files bypass exclude patterns — the whole assumption being that if you asked for a specific file, you obviously want it processed, right? 🤷‍♀️ but with --force-exclude, those patterns get honored regardless. and this is primarily intended for pre-commit hooks (and similar tooling), which pass changed files explicitly but should still respect the project's exclude configuration. so basically: the hook energy is real and we're respecting it 🪝✨
  • -h, --help — prints help (see a summary with -h) 🫶
  • -V, --version — prints version. yeah that's it 🌈
  • [FILES] — input file path(s) or directories (use - for stdin). lowkey important: that dash literally means stdin, don't forget it 💀

👑 VERSION 👑

v3.16.0 — the current era, the main character version fr fr ⭐

🎀 SEE ALSO 🎀

panache-debug(1), panache(1) — go read those too, they're iconic in their own right 💖

and that's the whole page bestie!! this was format version 3.16.0 of panache-debug-format(1) — slay, no cap, periodt. 🦋💜🌸
📦 where this page comes from