--- url: /docs/guide/usage/formatter/config-file-reference.md --- # Configuration options for the Oxfmt. Most options are the same as Prettier's options, but not all of them. In addition, some options are our own extensions. ## arrowParens type: `"always" | "avoid"` Include parentheses around a sole arrow function parameter. * Languages: JS, JSX, TS, TSX * Default: `"always"` ## bracketSameLine type: `boolean` Put the `>` of a multi-line HTML (HTML, JSX, Vue, Angular) element at the end of the last line, instead of being alone on the next line (does not apply to self closing elements). * Languages: JSX, TSX, HTML, Angular, Vue, MJML, Svelte * Default: `false` ## bracketSpacing type: `boolean` Print spaces between brackets in object literals. * Languages: JS, JSX, TS, TSX, JSON, JSONC, JSON5, GraphQL, YAML * Default: `true` ## embeddedLanguageFormatting type: `"auto" | "off"` Control whether to format embedded parts (For example, CSS-in-JS, or JS-in-Vue, etc.) in the file. * Languages: JS, JSX, TS, TSX, HTML, Vue, Angular, Svelte, Markdown, MDX (languages with embedded code) * Default: `"auto"` ## endOfLine type: `"lf" | "crlf" | "cr"` Which end of line characters to apply. NOTE: `"auto"` is not supported. * Languages: All * Default: `"lf"` * Overrides `.editorconfig.end_of_line` ## experimentalOperatorPosition type: `"start" | "end"` When expressions wrap lines, print operators at the start of new lines (`"start"`) or at the end of previous lines (`"end"`). * Languages: JS, JSX, TS, TSX * Default: `"end"` ## htmlWhitespaceSensitivity type: `"css" | "strict" | "ignore"` Specify the global whitespace sensitivity for HTML, Vue, Angular, and Handlebars. * Languages: HTML, Angular, Vue, Handlebars, Svelte * Default: `"css"` ## ignorePatterns type: `string[]` Ignore files matching these glob patterns. Patterns use gitignore-style matching, rooted at the directory containing the configuration file. Files outside that directory cannot be matched; patterns containing `..` are rejected as a configuration error. * Default: `[]` ## insertFinalNewline type: `boolean` Whether to insert a final newline at the end of the file. * Languages: All * Default: `true` * Overrides `.editorconfig.insert_final_newline` ## jsdoc type: `object | boolean` Enable JSDoc comment formatting. When enabled, JSDoc comments are normalized and reformatted: tag aliases are canonicalized, descriptions are capitalized, long lines are wrapped, and short comments are collapsed to single-line. Pass `true` or an object to enable with defaults, or omit/set `false` to disable. * Languages: JS, JSX, TS, TSX * Default: Disabled ### jsdoc.addDefaultToDescription type: `boolean` Append default values to `@param` descriptions (e.g. "Default is `value`"). * Default: `true` ### jsdoc.bracketSpacing type: `boolean` Add spaces inside JSDoc type braces: `{string}` → `{ string }`. * Default: `false` ### jsdoc.capitalizeDescriptions type: `boolean` Capitalize the first letter of tag descriptions. * Default: `true` ### jsdoc.commentLineStrategy type: `"singleLine" | "multiline" | "keep"` How to format comment blocks. * `"singleLine"` — Convert to single-line `/** content */` when possible. * `"multiline"` — Always use multi-line format. * `"keep"` — Preserve original formatting. * Default: `"singleLine"` ### jsdoc.descriptionTag type: `boolean` Emit `@description` tag instead of inline description. * Default: `false` ### jsdoc.descriptionWithDot type: `boolean` Add a trailing dot to the end of descriptions. * Default: `false` ### jsdoc.keepUnparsableExampleIndent type: `boolean` Preserve indentation in unparsable `@example` code. * Default: `false` ### jsdoc.lineWrappingStyle type: `"greedy" | "balance"` Strategy for wrapping description lines at print width. * `"greedy"` — Always re-wrap text to fit within print width. * `"balance"` — Preserve original line breaks if all lines fit within print width. * Default: `"greedy"` ### jsdoc.preferCodeFences type: `boolean` Use fenced code blocks (` ``` `) instead of 4-space indentation for code without a language tag. * Default: `false` ### jsdoc.separateReturnsFromParam type: `boolean` Add a blank line between the last `@param` and `@returns`. * Default: `false` ### jsdoc.separateTagGroups type: `boolean` Add blank lines between different tag groups (e.g. between `@param` and `@returns`). * Default: `false` ## jsxSingleQuote type: `boolean` Use single quotes instead of double quotes in JSX. * Languages: JSX, TSX * Default: `false` ## objectWrap type: `"preserve" | "collapse"` How to wrap object literals when they could fit on one line or span multiple lines. By default, formats objects as multi-line if there is a newline prior to the first property. Authors can use this heuristic to contextually improve readability, though it has some downsides. * Languages: JS, JSX, TS, TSX, JSON, JSONC, JSON5 * Default: `"preserve"` ## overrides type: `array` File-specific overrides. When a file matches multiple overrides, the later override takes precedence (array order matters). * Default: `[]` ### overrides\[n] type: `object` #### overrides\[n].excludeFiles type: `string[]` Glob patterns to exclude from this override. A set of glob patterns. Patterns are matched against paths relative to the configuration file's directory. #### overrides\[n].files type: `string[]` Glob patterns to match files for this override. A set of glob patterns. Patterns are matched against paths relative to the configuration file's directory. #### overrides\[n].options type: `object` Format options to apply for matched files. Accepts the same options as the top-level format options. ## printWidth type: `integer` Specify the line length that the printer will wrap on. If you don't want line wrapping when formatting Markdown, you can set the `proseWrap` option to disable it. * Languages: All * Default: `100` * Overrides `.editorconfig.max_line_length` ## proseWrap type: `"always" | "never" | "preserve"` How to wrap prose. By default, formatter will not change wrapping in markdown text since some services use a linebreak-sensitive renderer, e.g. GitHub comments and BitBucket. To wrap prose to the print width, change this option to "always". If you want to force all prose blocks to be on a single line and rely on editor/viewer soft wrapping instead, you can use "never". * Languages: Markdown, MDX, YAML * Default: `"preserve"` ## quoteProps type: `"as-needed" | "consistent" | "preserve"` Change when properties in objects are quoted. * Languages: JS, JSX, TS, TSX * Default: `"as-needed"` ## semi type: `boolean` Print semicolons at the ends of statements. * Languages: JS, JSX, TS, TSX * Default: `true` ## singleAttributePerLine type: `boolean` Enforce single attribute per line in HTML, Vue, and JSX. * Languages: JSX, TSX, HTML, Angular, Vue, MJML, Svelte * Default: `false` ## singleQuote type: `boolean` Use single quotes instead of double quotes. For JSX, you can set the `jsxSingleQuote` option. * Languages: JS, JSX, TS, TSX, CSS, Less, SCSS, Markdown, MDX, YAML, Handlebars, Svelte * Default: `false` * Overrides `.editorconfig.quote_type` ## sortImports type: `object | boolean` Sort import statements. Using the similar algorithm as [eslint-plugin-perfectionist/sort-imports](https://perfectionist.dev/rules/sort-imports). For details, see each field's documentation. Pass `true` or an object to enable with defaults, or omit/set `false` to disable. * Languages: JS, JSX, TS, TSX * Default: Disabled ### sortImports.customGroups type: `array` Define your own groups for matching very specific imports. The `customGroups` list is ordered: The first definition that matches an element will be used. Custom groups have a higher priority than any predefined group. If you want a predefined group to take precedence over a custom group, you must write a custom group definition that does the same as what the predefined group does, and put it first in the list. If you specify multiple conditions like `elementNamePattern`, `selector`, and `modifiers`, all conditions must be met for an import to match the custom group (AND logic). NOTE: Predefined group names (e.g. `side_effect`, `external`) and `unknown` are reserved and cannot be used as `groupName`. * Default: `[]` #### sortImports.customGroups\[n] type: `object` ##### sortImports.customGroups\[n].elementNamePattern type: `string[]` default: `[]` List of glob patterns to match import sources for this group. ##### sortImports.customGroups\[n].groupName type: `string` default: `""` Name of the custom group, used in the `groups` option. ##### sortImports.customGroups\[n].modifiers type: `array` Modifiers to match the import characteristics. All specified modifiers must be present (AND logic). ###### sortImports.customGroups\[n].modifiers\[n] type: `"side_effect" | "type" | "value" | "default" | "wildcard" | "named"` Modifier matching the import characteristics in `customGroups` (see `sortImports.groups` for semantics). ##### sortImports.customGroups\[n].selector type: `"type" | "side_effect_style" | "side_effect" | "style" | "index" | "sibling" | "parent" | "subpath" | "internal" | "builtin" | "external" | "import"` Selector to match the import kind. ### sortImports.groups type: `array` Specifies a list of predefined import groups for sorting. Each import will be assigned a single group specified in the groups option (or the `unknown` group if no match is found). The order of items in the `groups` option determines how groups are ordered. Within a given group, members will be sorted according to the type, order, ignoreCase, etc. options. Individual groups can be combined together by placing them in an array. The order of groups in that array does not matter. All members of the groups in the array will be sorted together as if they were part of a single group. Predefined groups are characterized by a single selector and potentially multiple modifiers. You may enter modifiers in any order, but the selector must always come at the end. The list of selectors is sorted from most to least important: * `type` — TypeScript type imports. * `side_effect_style` — Side effect style imports. * `side_effect` — Side effect imports. * `style` — Style imports. * `index` — Main file from the current directory. * `sibling` — Modules from the same directory. * `parent` — Modules from the parent directory. * `subpath` — Node.js subpath imports. * `internal` — Your internal modules. * `builtin` — Node.js Built-in Modules. * `external` — External modules installed in the project. * `import` — Any import. The list of modifiers is sorted from most to least important: * `side_effect` — Side effect imports. * `type` — TypeScript type imports. * `value` — Value imports. * `default` — Imports containing the default specifier. * `wildcard` — Imports containing the wildcard (`* as`) specifier. * `named` — Imports containing at least one named specifier. * Default: See below ```json ["builtin", "external", ["internal", "subpath"], ["parent", "sibling", "index"], "style", "unknown"] ``` Also, you can override the global `newlinesBetween` setting for specific group boundaries by including a `{ "newlinesBetween": boolean }` marker object in the `groups` list at the desired position. #### sortImports.groups\[n] type: `object | array | string` ##### sortImports.groups\[n].newlinesBetween type: `boolean` ### sortImports.ignoreCase type: `boolean` Specifies whether sorting should be case-sensitive. * Default: `true` ### sortImports.internalPattern type: `string[]` Specifies a prefix for identifying internal imports. This is useful for distinguishing your own modules from external dependencies. * Default: `["~/", "@/", "#"]` ### sortImports.newlinesBetween type: `boolean` Specifies whether to add newlines between groups. When `false`, no newlines are added between groups. * Default: `true` ### sortImports.order type: `"asc" | "desc"` Specifies whether to sort items in ascending or descending order. * Default: `"asc"` ### sortImports.partitionByComment type: `boolean` Enables the use of comments to separate imports into logical groups. When `true`, all comments will be treated as delimiters, creating partitions. ```js import { b1, b2 } from "b"; // PARTITION import { a } from "a"; import { c } from "c"; ``` * Default: `false` ### sortImports.partitionByNewline type: `boolean` Enables the empty line to separate imports into logical groups. When `true`, formatter will not sort imports if there is an empty line between them. This helps maintain the defined order of logically separated groups of members. ```js import { b1, b2 } from "b"; import { a } from "a"; import { c } from "c"; ``` * Default: `false` ### sortImports.sortSideEffects type: `boolean` Specifies whether side effect imports should be sorted. By default, sorting side-effect imports is disabled for security reasons. * Default: `false` ## sortPackageJson type: `object | boolean` Sort `package.json` keys. The algorithm is NOT compatible with [prettier-plugin-sort-packagejson](https://github.com/matzkoh/prettier-plugin-packagejson). But we believe it is clearer and easier to navigate. For details, see each field's documentation. * Languages: JSON (`package.json` only) * Default: `true` ### sortPackageJson.sortScripts type: `boolean` Sort the `scripts` field alphabetically. * Default: `false` ## sortTailwindcss type: `object | boolean` Sort Tailwind CSS classes. Using the same algorithm as [prettier-plugin-tailwindcss](https://github.com/tailwindlabs/prettier-plugin-tailwindcss). Option names omit the `tailwind` prefix used in the original plugin (e.g., `config` instead of `tailwindConfig`). For details, see each field's documentation. Pass `true` or an object to enable with defaults, or omit/set `false` to disable. * Languages: JS, JSX, TS, TSX, HTML, Vue, Angular, Handlebars, CSS, SCSS, Less, Svelte * Default: Disabled ### sortTailwindcss.attributes type: `string[]` List of additional attributes to sort beyond `class` and `className` (exact match). NOTE: Regex patterns are not yet supported. * Default: `[]` * Example: `["myClassProp", ":class"]` ### sortTailwindcss.config type: `string` Path to your Tailwind CSS configuration file (v3). NOTE: Paths are resolved relative to the Oxfmt configuration file. * Default: Automatically find `"tailwind.config.js"` ### sortTailwindcss.functions type: `string[]` List of custom function names whose arguments should be sorted (exact match). NOTE: Regex patterns are not yet supported. * Default: `[]` * Example: `["clsx", "cn", "cva", "tw"]` ### sortTailwindcss.preserveDuplicates type: `boolean` Preserve duplicate classes. * Default: `false` ### sortTailwindcss.preserveWhitespace type: `boolean` Preserve whitespace around classes. * Default: `false` ### sortTailwindcss.stylesheet type: `string` Path to your Tailwind CSS stylesheet (v4). NOTE: Paths are resolved relative to the Oxfmt configuration file. * Default: Installed Tailwind CSS's `theme.css` ## svelte type: `object | boolean` Options for `prettier-plugin-svelte`. Pass `true` or an object to enable `.svelte` file formatting, or `false` (handy in overrides) / omit to disable. Setting `true` resets to defaults — any options inherited from a parent scope are dropped. NOTE: `prettier-plugin-svelte` requires the `svelte` package (`svelte/compiler`) at runtime, but Oxfmt does NOT bundle or auto-install it. You must install `svelte` yourself in your project, formatting will fail at runtime otherwise. * Languages: Svelte * Default: Disabled ### svelte.allowShorthand type: `boolean` Whether to allow attribute shorthand if attribute name and expression are same. * Default: `true` ### svelte.indentScriptAndStyle type: `boolean` Whether to indent code inside `