fatou-format(1)

πŸ“¦ version 0.24.0, in nixpkgs unstable

πŸ’… NAME πŸ’…

okay so bestie, meet fatou-format β€” the little icon that formats your .jl files. that's it. that's the whole job. and it slays at it. ✨


🌸 SYNOPSIS 🌸

fatou format [--check] [--safe] [--line-width] [--indent-width]
[--exclude] [--force-exclude] [-h|--help] [-V|--version] [PATH]

like, that's the whole vibe check. put it in your terminal and go off. 🫢


πŸ¦‹ DESCRIPTION πŸ¦‹

fatou-format formats .jl files. no cap, that's genuinely the entire description. it takes your Julia files and makes them pretty. main character energy only. πŸ‘‘


πŸŽ€ OPTIONS πŸŽ€

  • --check β€” the "look but don't touch" option, respectful king behavior. checks the formatting without writing anything; prints a diff and exits non-zero if any file would change. > ⚠️ heads up bestie: this one requires path arguments, because when you're reading from stdin there's literally no file on disk to report on. iykyk. πŸ’€
  • --safe β€” the paranoid bestie of the group chat, and honestly? obsessed. verifies that formatting preserves the parsed program and comments. it straight up refuses malformed or unverifiable input, and for path batches everything gets fully checked before any file is written. safety first, always. πŸ›‘οΈβœ¨
  • --line-width <N> β€” override the target line width. you want longer lines? shorter lines? go off, set your own rules. <N> is the number, in case that wasn't clear. πŸ“
  • --indent-width <N> β€” override the indent width. same deal, <N> is your number. your indentation, your choice. πŸ’…
  • --exclude <PATTERN> β€” add extra gitignore-style exclude patterns. it's repeatable or comma-separated (yes, both, we contain multitudes πŸ¦‹), and it augments the configured exclude/extend-exclude. so like, it adds to what's already there, doesn't replace it. ✨
  • --force-exclude β€” okay so normally, files you name explicitly on the command line are always processed, no matter what. this flag flips that: exclude patterns get applied to explicitly-named files too. it exists for runners like pre-commit that pass staged files as arguments β€” they need the exclude rules to actually stick. not me making pre-commit work properly 😭🫢
  • -h, --help β€” print help. the classic. the icon. 🌈
  • -V, --version β€” print version. short and sweet. ⭐
  • [PATH] β€” input file(s) or director(ies). pass - for stdin β€” and it also reads stdin when paths are omitted and stdin is not a terminal. clever little thing, it just knows. πŸ§šπŸ’œ

πŸ”₯ VERSION πŸ”₯

v0.24.0

that's the version. that's the number. write it down. πŸ“


πŸ‘‘ SEE ALSO πŸ‘‘

the whole squad, fr fr. go say hi to all of them. πŸ’–


and that's a wrap, bestie!! this page is from format 0.24.0 β€” go forth and format, you gorgeous creature πŸ¦‹πŸ’…βœ¨πŸŽ€

πŸ“¦ where this page comes from