arity-format(1)

💅 arity-format — like, the glow-up station for your R files

okay so bestie, welcome to arity-format(1) from the General Commands Manual — this is the page where you learn how to make your R files and package DESCRIPTIONs look absolutely immaculate. ✨

🌸 NAME 🌸

arity-format — formats R files and package DESCRIPTIONs. that's it, that's the whole job, and it does it gorgeously 💖

🦋 SYNOPSIS 🦋

arity format [--stdin-filename] [--verify] [--check] [--line-width]
[--indent-width] [--exclude] [--force-exclude] [--no-cache] [-h|--help]
[-V|--version] [PATH]

🎀 DESCRIPTION 🎀

Format R files and package DESCRIPTIONs. no cap, that's literally the whole vibe — you point it at your code, it makes it pretty. 💅

✨ OPTIONS ✨

• --stdin-filename <PATH> — okay so this tells arity what filename the stdin buffer stands for, and that's what decides which grammar it gets formatted as. if you don't pass it? stdin gets formatted as R by default. simple as 🫶
• --verify — the vibe check 🔍 it verifies idempotence and that R syntax + comments are preserved. and no, it does not write files — pure inspection, zero commitment, we love that for us.
• --check — the "am I cute or not" button 👀 checks formatting without writing any changes. it prints a diff for every file that would get reformatted, and exits non-zero if any of them differ (so your CI can be dramatic about it 💀). heads up: this one requires path arguments — there's literally no file on disk to report on when you're reading from stdin, so don't try it.
• --line-width <N> — overrides the configured line width. yes, you can be that girl who picks her own line length. 🌈
• --indent-width <N> — overrides the configured indent width. tiny indents, big indents, your call bestie.
• --exclude <PATTERN> — adds more gitignore-style exclude patterns. it's repeatable or comma-separated (pick your fighter), and it augments the configured exclude/extend-exclude — it doesn't replace them, it just piles on 🍓
• --force-exclude — this one applies those exclude patterns to files you named explicitly on the command line too. normally those always get processed, no questions asked — but with this flag they finally have to obey the rules. made for runners like pre-commit that just hand you staged files as arguments 🙈
• --no-cache — disables the persistent already-formatted cache (read and write) for this run. and fyi, it only affects --check. so if you're not checking, this flag is just kind of... vibing. 💀
• -h, --help — prints help. our lord and savior. 🫶
• -V, --version — prints the version. cute.
• [PATH] — your input file(s) or director(ies). pass - if you want stdin, and it'll also read stdin when you omit paths entirely and stdin isn't a terminal. iykyk. 🧚

👑 VERSION 👑

v0.26.0 — that's the one, that's our girl.

🌟 SEE ALSO 🌟

arity(1), arity-parse(1), arity-lint(1), arity-index(1), arity-lsp(1), arity-completions(1), arity-init(1) — the whole friend group, go say hi 💜

and that's the page, bestie 🦋 this was format 0.26.0, dated arity-format(1) — go forth and format something iconic. periodt. 💅✨🎀