panache-format(1)

💖 panache-format(1) — General Commands Manual 💖

🌸 NAME 🌸

panache-format — Format a Quarto or other Markdown document. Bestie, this is the page for the panache format command, and it is giving very “make your Markdown cute and consistent” energy 💅

✨ SYNOPSIS ✨

panache format [--check] [--range] [--force-exclude] [-o|--option] [-h|--help] [-V|--version] [FILES]

🦋 DESCRIPTION 🦋

Okay so panache-format formats a Quarto or other Markdown document according to Panache's formatting rules. By default, it formats files in place. Use --check to verify formatting without making any changes. Stdin input always outputs to stdout — no cap.

🎀 OPTIONS 🎀

• --check — Checks if the file is already formatted according to Panache's rules without making any changes. If the file is not formatted, it displays a diff and exits with code 1. If it is formatted, it exits with code 0. Useful for CI/CD pipelines. Very “is this already slaying?” energy 🔥
• --range <START:END> — Formats only the specified line range. Lines are 1-indexed and inclusive. The range will be expanded to complete block boundaries to ensure well-formed output. For example, if you select part of a list, the entire list will be formatted. Format: --range START:END (e.g., --range 5:10 formats lines 5 through 10).

Note: This feature is experimental. Range filtering may not work correctly in all cases. 🫶

• --force-exclude — Applies exclude patterns from your configuration even to files passed explicitly on the command line.

By default, explicitly-named files bypass exclude patterns: the assumption is that if you asked for a specific file, you want it processed. With --force-exclude, those patterns are honored regardless.

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. 👑

• -o, --option <KEY=VALUE> — Overrides an individual config option for this invocation, using the kebab-case key names from panache.toml. May be repeated. Takes precedence over both panache.toml and the built-in defaults.

Supported keys: line-width (positive integer, measured in Unicode display columns, where East Asian wide characters count as 2: x宮 is 3 columns, not 2 characters or 4 UTF-8 bytes); wrap (one of: reflow, sentence, semantic, preserve); and extensions.<name>=<bool> to toggle any extension (booleans accept true/false/1/0/yes/no/on/off).

Example: --option line-width=100 -o wrap=sentence -o extensions.east-asian-line-breaks=true.

Note: this is an escape hatch for ad-hoc invocations. Prefer panache.toml so that everyone formatting the repository gets the same result. 🧚

• -h, --help — Print help (see a summary with -h). Literally what it says, bestie 💖
• -V, --version — Print version. ✨
• [FILES] — Path(s) to the input file(s) or directories to format. If not provided, or if the single argument - is given, reads from stdin (with no arguments at an interactive terminal this is a usage error instead, since there is nothing to read). Supports .qmd, .md, .Rmd/.Rmarkdown, and other Markdown-based formats. When file paths are provided, the files are formatted in place by default. Stdin input always outputs to stdout. Supports glob patterns (e.g., *.md) and directories (e.g., . or docs/). Directories are traversed recursively, respecting .gitignore files. - cannot be combined with other paths.

🌈 VERSION 🌈

v3.16.0

💜 SEE ALSO 💜

• panache(1)
• panache-parse(1)
• panache-lsp(1)
• panache-lint(1)
• panache-clean(1)
• panache-debug(1)

---

Okay bestie, that's the whole manual page 💅✨ This one is from the General Commands Manual: panache-format(1), version v3.16.0, footer source/version format 3.16.0 — and there's no date in the footer, so I'm not inventing one. Bye bestie, go format something iconic 🫶🎀