Options

Options go in a config file, at the top level or inside a language section. Most also have a command-line flag; see CLI.

Names are shorter than Prettier's, because the prefix is implied: width, not printWidth. The behaviour is Prettier's.

Completion in your editor

tidy ships a JSON Schema for its own config. Point $schema at it and an editor completes every key, shows its default, and marks a typo before tidy does:

{
  "$schema": "https://tidy.lukeed.com/tidy.schema.json",
  "width": 100
}

The same file is in the tidyrs package, for a project that would rather not fetch it:

{
  "$schema": "./node_modules/tidyrs/tidy.schema.json"
}

Or print it from the binary:

$ tidy schema > tidy.schema.json

The schema is generated from the same table the parser is checked against, so it cannot describe an option tidy does not take, or miss one it does. The playground completes the config pane from it.

Shared options

These are valid at the top level and inside any language section.

width, indent, tabs, eol, ignore and embedded reach every language. width defaults to 120 for Dockerfiles, and whitespace to "strict" for XML. The rest reach only where the idea applies:

• whitespace — HTML, Vue, Handlebars and XML.
• quote — Handlebars, style sheets, JSON5, YAML and JS.
• trailingComma — SCSS, JSONC, JSON5, YAML flow collections, TOML arrays and JS.
• bracketSpacing — JSON and JS objects, and YAML flow mappings.
• bracketSameLine, singleAttributePerLine — HTML, Vue, XML and JSX.

ignore names the ignore directive; embedded turns embedded code on and off.

{
  "width": 100,
  "tabs": true,
  "quote": "single",
  "css": { "quote": "double" }
}

Language sections

Each section takes every shared option, plus its own.

js

Covers JavaScript, TypeScript, JSX and TSX, and JavaScript wherever tidy formats it inside another language.

jsdoc formats JSDoc comments the way prettier-plugin-jsdoc does. It is on by default, which is one of tidy's two departures from Prettier's defaults — see Option philosophy. Turn it off with "js": { "jsdoc": false }.

Sorting imports

Off by default. Two ways to turn it on:

{
  "js": { "sortImports": true }
}

That is oxfmt's sorter. Or name a Prettier plugin you already configure, and give it its own options:

{
  "js": {
    "plugins": ["@ianvs/prettier-plugin-sort-imports"],
    "importOrder": ["^node:", "<THIRD_PARTY_MODULES>", "^[./]"]
  }
}

The plugins understood are @trivago/prettier-plugin-sort-imports, @ianvs/prettier-plugin-sort-imports and prettier-plugin-organize-imports. tidy does not load the package — it ports the sorter and reads that plugin's option names, so the behaviour follows the config you already have. No other Prettier plugin is supported.

markdown

The one section with more than Prettier offers. The default is Prettier's behaviour exactly.

"preset": "preserve" sets every marker option to "keep", so tidy normalises the layout of blocks and leaves your markers alone. It also renames the ignore directive to tidy-ignore; set markdown.ignore to change it back.

{
  "markdown": { "preset": "preserve", "wrap": "always", "width": 80 }
}

Adjacent sibling lists alternate markers, so that two lists in a row stay two lists.

json

Covers JSON, JSONC, JSON5 and package.json.

yaml

vue

handlebars

xml

Covers XML, SVG and the other file types @prettier/plugin-xml handles. Its options keep that plugin's names.

toml

taplo's settings, in camel case. Defaults are taplo's.

alignEntries, alignComments, alignSingleComments, arrayAutoExpand, arrayAutoCollapse, inlineTableExpand, compactArrays, compactInlineTables, compactEntries, indentTables, indentEntries, trailingNewline, reorderKeys, reorderArrays, reorderInlineTables are booleans. allowedBlankLines is a number.

{
  "toml": { "alignEntries": true, "reorderKeys": false }
}

dockerfile

dprint-plugin-dockerfile's settings.

ini

Covers .ini, .cfg, .editorconfig, .npmrc, .gitconfig and the rest.

html, css, graphql

Shared options only. css covers SCSS and Less.

Prettier options with no equivalent