[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8,"_9":10,"_11":12},"actionData","errors","root",{"_164":-5,"_167":168,"_169":170},"routes/shell",{"_41":42,"_163":-5,"_164":-5,"_165":166},"routes/repo",{"_34":-7,"_35":36,"_37":38,"_39":40,"_41":42,"_43":32,"_44":32,"_45":32,"_46":32,"_47":32,"_48":32,"_49":50,"_51":52,"_53":32,"_54":-7,"_55":-7,"_56":57,"_58":59,"_60":61,"_62":-5,"_63":64,"_65":66,"_67":68,"_69":70},"routes/repo.blob",{"_13":14,"_15":16,"_17":18,"_19":20,"_21":22,"_23":24,"_25":-5,"_26":27,"_28":29,"_29":30,"_31":32,"_33":14},"ref","main","path","www/content/docs/cli.md","oid","7ab569ff67aba54849ac61c620f966e25ff7b47c","size",8011,"commit","12e96b5435e408a25422fcfd87d6fa5474b6e53a","mounts",[],"source","plain",{"_13":14,"_15":16},"kind","text","---\ntitle: CLI\nsummary: Every flag of the tidy command, what it does, and the exit codes it returns.\ngroup: Usage\norder: 2\n---\n\n```sh\n$ tidy [paths...] [options] # print the formatted file\n$ tidy up [paths...] [options] # rewrite files in place\n$ tidy check [paths...] [options] # list what isn't formatted\n```\n\n```sh\n# print one file, formatted\n$ tidy index.html\n\n# list the files that aren't formatted; exits 1 if any\n$ tidy check src\n\n# rewrite everything in place\n$ tidy up .\n\n# a different width for one run\n$ tidy up . --width 100\n```\n\n## Commands\n\n| Command | What it does |\n| ------------ | ----------------------------------------------------------------------------------------------- |\n| `tidy` | Print the formatted result to stdout. |\n| `tidy up` | Rewrite each file in place, and print what it rewrote. Files already formatted are not touched. |\n| `tidy check` | Print the paths that are not formatted. Changes nothing. Exits 1 if any. |\n\nBare `tidy` reads stdin when it gets no paths, and takes one file otherwise. `up` and `check` take as many paths as you like, and the current folder when you give none.\n\n```sh\n$ tidy check # the same as: tidy check .\n$ cat a.ts | tidy --stdin-filepath a.ts\n```\n\nA folder named `up` or `check` is read as the command, not as a path. Write `./up` to mean the folder.\n\n## Only what git says changed\n\nInstead of naming paths, let git name them. Both work with `up` and `check`, and not with bare `tidy`.\n\n| Flag | What it does |\n| ------------------- | ------------------------------------------------------------------------------------------------------------ |\n| `--staged` | Only files staged in the index. `tidy up` stages what it rewrote, so the commit holds the formatted version. |\n| `--changed[=]` | Only files that differ from a branch or commit. Without a value, the default branch. |\n\n```sh\n# a pre-commit hook, in one line\n$ tidy up --staged\n\n# everything this branch touched\n$ tidy check --changed\n\n# against a named branch or commit\n$ tidy check --changed=main\n$ tidy check --changed=HEAD~3\n```\n\n`--changed` compares the working tree against the merge base of the ref and `HEAD`, so it covers what you committed on this branch _and_ what you have not committed yet. New files that git does not track yet are included; files a `.gitignore` covers are not.\n\nThe default branch is `origin/HEAD` where that is set, else `main`, else `master`. If none of those exist, name the ref yourself.\n\nA path narrows what git named, rather than adding to it:\n\n```sh\n# only the changed files under src/\n$ tidy check --changed=main src\n```\n\nWhen git names no file tidy can format, the run succeeds and prints nothing — a commit that touches no formattable file is not a failure.\n\n`--changed` takes its value with `=`, because `--changed main` cannot be told apart from `--changed` followed by the path `main`.\n\n## Choosing files\n\n| Flag | What it does |\n| ------------------------- | ----------------------------------------------------------------------------------------------- |\n| `--parser ` | Force a language instead of guessing from the file name. |\n| `--stdin-filepath ` | The path the text on stdin would have, which decides its language and which config files apply. |\n| `--threads ` | How many files to format at once. Defaults to one per core; `1` uses a single thread. |\n\n`--parser` takes `html`, `vue`, `mjml`, `handlebars`, `tempura`, `css`, `scss`, `less`, `json`, `jsonc`, `json5`, `json-stringify`, `yaml`, `toml`, `dockerfile`, `ini`, `gitconfig`, `graphql`, `babel`, `typescript`, `babel-ts`, `xml` or `markdown`. The names are Prettier's.\n\nWhen tidy walks a folder it skips `node_modules` and every folder whose name starts with `.`. It does not read `.gitignore`. To leave other paths out, pass the paths you do want, or see [Ignoring code](/docs/ignore/).\n\n## Config\n\n| Flag | What it does |\n| ----------------- | ----------------------------------------------------------- |\n| `--config ` | Use this config for every file, instead of the nearest one. |\n| `--no-config` | Read no config files, and no `.editorconfig`. |\n\nWithout either, each file takes the nearest `tidy.json`, `tidy.jsonc` or `tidy.toml`, on top of any `.editorconfig` that applies. Options given on the command line override both. See [Configuration file](/docs/configuration/).\n\n## Style\n\nEvery one of these has a config equivalent, documented in [Options](/docs/options/).\n\n| Flag | Default | What it does |\n| ----------------------------- | ----------------- | ---------------------------------------------------------------------------- |\n| `--width ` | `80` | The line width the printer fits to. `120` for Dockerfiles. |\n| `--indent ` | `2` | The width of one indent. |\n| `--tabs` | off | Indent with tabs. |\n| `--eol ` | `lf` | Line endings: `lf`, `crlf` or `cr`. |\n| `--whitespace ` | `auto` | HTML whitespace sensitivity: `strict`, `auto` or `ignore`. `strict` for XML. |\n| `--quote ` | `double` | Quotes in Handlebars, style sheets, JSON5, YAML and JS. |\n| `--no-trailing-comma` | | No trailing commas in SCSS, JSONC, JSON5, YAML, TOML and JS. |\n| `--no-bracket-spacing` | | No spaces inside the braces of JSON and JS objects, and YAML flow mappings. |\n| `--single-attribute-per-line` | off | Put each attribute on its own line. |\n| `--bracket-same-line` | off | Keep the `>` of a multi-line tag on the last line. |\n| `--ignore ` | `prettier-ignore` | The name of the ignore directive. |\n| `--no-embedded` | | Leave code of other languages inside a file as it is written. |\n\n## Other\n\n| Flag | What it does |\n| ----------------- | ------------------ |\n| `-v`, `--version` | Print the version. |\n| `-h`, `--help` | Print help. |\n\n## Exit codes\n\n| Code | Means |\n| ---- | ------------------------------------------------------------------------------------------- |\n| `0` | Success. With `check`, every file is formatted. |\n| `1` | With `check`, at least one file is not formatted. |\n| `2` | Something failed: a file would not parse, a path could not be read, or an option was wrong. |\n\nA `check` run that cannot parse a file exits `2`, not `1`, so a broken file is never reported as merely unformatted.\n\n## stdin\n\n```sh\n$ cat index.html | tidy --stdin-filepath index.html\n$ echo '{\"a\":1}' | tidy --parser json\n```\n\nWithout `--stdin-filepath` or `--parser`, tidy treats stdin as HTML. `--stdin-filepath` is the better of the two, because it also decides which config files apply.\n","editable",false,"branch","documentNavigation","repo","lukeed/tidy","repoId","b2cac5cc-818f-4958-803a-7d401ccd9a90","ownerId","user:5855893","site","nexthub","private","admin","settings","maintainer","triage","starred","stars",0,"watchers",1,"watching","pinned","notify","views",[119,120,121,122,123,124,125,126,127,128,129,130,131],"navigation",{"_56":57,"_78":79,"_80":81,"_82":83,"_84":85,"_86":87,"_88":89},"sources",[],"viewer","meta",{"_71":72,"_73":74,"_75":72,"_43":32,"_76":14,"_77":32,"_49":50,"_51":52},"branches",[14],"tags",[],"cloneUrl","https://git.nexthub.sh/lukeed/tidy.git","description","","owner","lukeed","section","head","empty","pins",[101,102,103],"documents",{"_98":99,"_100":50},"code",{"_95":96,"_97":50},"automations",{"_92":93,"_94":-5},"delivery",{"_90":50,"_91":-5},"tag","W1_y18R9FUcyveBRlHeRXdVTtjo","releases","applications","workflows",2,"deployments","commits",350,"changes","counts",{},"total",{"_104":97,"_106":117,"_15":97,"_108":118,"_54":110,"_111":32,"_112":110,"_113":50},{"_104":114,"_106":115,"_15":114,"_108":116,"_54":110,"_111":32,"_112":110,"_113":50},{"_104":105,"_106":107,"_15":105,"_108":109,"_54":110,"_111":32,"_112":110,"_113":50},"id","issues","name","Issues","filters",{},true,"saved","pinnable","count","tasks","Tasks",{},"Changes",{},{"_104":97,"_106":117,"_15":97,"_108":162,"_54":110,"_111":32,"_112":110},{"_104":114,"_106":115,"_15":114,"_108":161,"_54":110,"_111":32,"_112":110},{"_104":105,"_106":107,"_15":105,"_108":160,"_54":110,"_111":32,"_112":110},{"_104":157,"_106":158,"_15":157,"_108":159,"_54":32,"_111":32,"_112":110},{"_104":154,"_106":155,"_15":154,"_108":156,"_54":32,"_111":32,"_112":110},{"_104":92,"_106":152,"_15":84,"_108":153,"_54":32,"_111":32,"_112":110},{"_104":94,"_106":149,"_15":150,"_108":151,"_54":32,"_111":32,"_112":110},{"_104":90,"_106":147,"_15":90,"_108":148,"_54":32,"_111":32,"_112":110},{"_104":143,"_106":144,"_15":145,"_108":146,"_54":32,"_111":32,"_112":110},{"_104":80,"_106":141,"_15":80,"_108":142,"_54":32,"_111":32,"_112":32},{"_104":138,"_106":139,"_15":138,"_108":140,"_54":32,"_111":32,"_112":32},{"_104":135,"_106":136,"_15":135,"_108":137,"_54":32,"_111":32,"_112":32},{"_104":132,"_106":133,"_15":132,"_108":134,"_54":32,"_111":32,"_112":32},"decisions","Decisions",{},"changelog","Changelog",{},"roadmap","Roadmap",{},"Documents",{},"activity","Activity","insights",{},"Releases",{},"Deployments","automations/deployments",{},"Workflows",{},"discussions","Discussions",{},"goals","Goals",{},{},{},{},"groups","user","agents",[],"now",1794435930043,"sidebar","expanded"]