Lintel Configuration

Configuration for the Lintel JSON/YAML schema validator.

Type object
File match lintel.toml **/lintel.toml
Schema URL https://catalog.lintel.tools/schemas/lintel/lintel-toml/latest.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Configuration file for the Lintel JSON/YAML schema validator.

Lintel walks up the directory tree from the validated file looking for lintel.toml files and merges them together. Settings in child directories take priority over parent directories. Set root = true to stop the upward search.

Place lintel.toml at your project root (or any subdirectory that needs different settings).

Properties

root boolean

Mark this configuration file as the project root.

When true, Lintel stops walking up the directory tree and will not merge any lintel.toml files from parent directories. Use this at your repository root to prevent inheriting settings from enclosing directories.

Default: false
exclude string[]

Glob patterns for files to exclude from validation.

Matched against file paths relative to the working directory. Standard glob syntax is supported: * matches within a single directory, ** matches across directory boundaries.

Default:
[]
Examples: ["vendor/**","testdata/**","*.generated.json"]
schemas Record<string, string>

Custom schema-to-file mappings.

Keys are glob patterns matched against file paths; values are schema URLs (or //-prefixed local paths) to apply. These mappings take priority over catalog auto-detection but are overridden by inline $schema properties and YAML modeline comments.

Example:

[schemas]
"config/*.yaml" = "<https://json.schemastore.org/github-workflow.json>"
"myschema.json" = "//schemas/custom.json"
Default:
{}
no-default-catalog boolean

Disable the built-in Lintel catalog.

When true, only SchemaStore and any additional registries listed in registries are used for schema auto-detection. The default Lintel catalog (which provides curated schema mappings) is skipped.

Default: false
registries string[]

Additional schema catalog URLs to fetch alongside SchemaStore.

Each entry should be a URL pointing to a JSON file in SchemaStore catalog format ({"schemas": [...]}).

Registries from child configs appear first, followed by parent registries (duplicates are removed). This lets child directories add project-specific catalogs while inheriting organization-wide ones.

Default:
[]
Examples: ["https://example.com/custom-catalog.json"]
rewrite Record<string, string>

Schema URI rewrite rules.

Keys are URI prefixes to match; values are replacement prefixes. The longest matching prefix wins. Use // as a value prefix to reference paths relative to the directory containing lintel.toml.

Example:

[rewrite]
"<http://localhost:8000/>" = "//schemas/"

This rewrites <http://localhost:8000/foo.json> to //schemas/foo.json, which then resolves to a local file relative to the config directory.

Default:
{}
override Override[]

Per-file or per-schema override rules.

In TOML, each override is written as a [[override]] block (double brackets). Earlier entries take priority; child config overrides come before parent config overrides after merging.

format Format | null

Formatting configuration for lintel format.

Definitions

Override object

Conditional settings applied to files or schemas matching specific patterns.

Each [[override]] block targets files by path glob, schemas by URI glob, or both. When a file matches, the settings in that block override the top-level defaults. Earlier entries (from child configs) take priority over later entries (from parent configs).

In TOML, override blocks are written as [[override]] (double brackets) to create an array of tables.

files string[]

Glob patterns matched against instance file paths (relative to the working directory).

Use standard glob syntax: * matches any single path component, ** matches zero or more path components, and ? matches a single character.

Default:
[]
Examples: ["schemas/vector.json"], ["schemas/**/*.json"], ["config/*.yaml"]
schemas string[]

Glob patterns matched against schema URIs.

Each pattern is tested against both the original URI (before rewrite rules) and the resolved URI (after rewrites and // prefix resolution), so you can match on either form.

Default:
[]
Examples: ["https://json.schemastore.org/vector.json"], ["https://json.schemastore.org/*.json"]
validate_formats boolean | null

Enable or disable JSON Schema format keyword validation for matching files.

When true, string values are validated against built-in formats such as date-time, email, uri, etc. When false, format annotations are ignored during validation. When omitted, this override does not affect the format validation setting and the next matching override (or the default of true) applies.

Default: null
Format object

Formatting configuration.

Controls how lintel format behaves. The dprint field passes configuration through to the dprint-based formatters (JSON, TOML, Markdown) and pretty_yaml.

dprint DprintConfig | null

dprint formatter configuration.

Global fields (lineWidth, indentWidth, useTabs, newLineKind) apply to all formatters. Per-plugin sections (json, toml, markdown) override the global defaults for that plugin.

DprintConfig Record<string, object>

Schema for a dprint configuration file.

$schema string | null

The JSON schema URL for editor validation and autocompletion.

The dprint VS Code extension automatically constructs a composite schema based on the installed plugins, so you usually don't need to set this manually.

incremental boolean | null

Only format files that have changed since the last formatting run.

When true (the default), dprint tracks which files have been formatted and skips unchanged files on subsequent runs. Set to false to always reformat all matched files.

Can also be toggled via the --incremental / --incremental=false CLI flag.

extends Extends | null

One or more configuration files to extend.

Can be a single path/URL or an array of paths/URLs. Properties from extended configs are merged, with the current file taking precedence. Earlier entries in an array take priority over later ones.

Supports the ${configDir} variable (resolves to the directory of the current config file) and ${originConfigDir} (resolves to the directory of the original/root config file).

When extending remote configs (URLs), includes and non-Wasm plugins entries are ignored for security.

lineWidth integer | null

The maximum line width the formatter tries to stay under.

The formatter may exceed this width in certain cases where breaking the line would produce worse output. This is a global default that individual plugins can override in their configuration sections.

format=uint32min=0
indentWidth integer | null

The number of characters for each indent level.

When useTabs is true, this controls the visual width of each tab character. When useTabs is false, this is the number of spaces inserted per indent level. This is a global default that individual plugins can override in their configuration sections.

format=uint32min=0
useTabs boolean | null

Whether to use tabs (true) or spaces (false) for indentation.

This is a global default that individual plugins can override in their configuration sections.

newLineKind NewLineKind | null

The newline character style to use when formatting.

This is a global default that individual plugins can override in their configuration sections.

includes array | null

Glob patterns for files to include in formatting.

When specified, only files matching at least one of these patterns are formatted. When omitted, all files matched by installed plugins are formatted (respecting excludes).

Uses gitignore-style glob syntax.

Examples: ["src/**/*.{ts,tsx,json}"]
excludes array | null

Glob patterns for files or directories to exclude from formatting.

Uses gitignore-style glob syntax. Files already ignored by .gitignore are excluded automatically. Prefix a pattern with ! to un-exclude files that were previously excluded.

Examples: ["**/*-lock.json","**/node_modules"]
plugins array | null

Plugin URLs or local file paths.

Each entry is a URL to a WebAssembly plugin (.wasm) or a local file path. The order determines precedence when multiple plugins can handle the same file extension — the first matching plugin wins.

Can also be specified via the --plugins CLI flag.

Examples: ["https://plugins.dprint.dev/typescript-0.93.3.wasm","https://plugins.dprint.dev/json-0.19.4.wasm"]
typescript TypeScriptConfig | null

TypeScript / JavaScript plugin configuration.

See: https://dprint.dev/plugins/typescript/config/

json JsonConfig | null

JSON plugin configuration.

See: https://dprint.dev/plugins/json/config/

toml TomlConfig | null

TOML plugin configuration.

See: https://dprint.dev/plugins/toml/config/

markdown MarkdownConfig | null

Markdown plugin configuration.

See: https://dprint.dev/plugins/markdown/config/

Extends string | string[]

One or more configuration files to extend.

Can be a single path/URL string or an array of paths/URLs. Properties from extended configs are merged, with the current file taking precedence. Earlier entries in an array take priority over later ones.

Supports the ${configDir} variable (resolves to the directory containing the current config file) and ${originConfigDir} (resolves to the directory of the original/root config file).

When extending remote configs (URLs), includes and non-Wasm plugins entries are ignored for security.

NewLineKind string | string | string | string

The newline character style to use when formatting files.

TypeScriptConfig object

Configuration for the dprint TypeScript / JavaScript plugin.

See: https://dprint.dev/plugins/typescript/config/

locked boolean | null

Whether the configuration is not allowed to be overridden or extended.

associations array | null

File patterns to associate with this plugin.

arguments.preferHanging PreferHanging | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: "never"

See: https://dprint.dev/plugins/typescript/config/#argumentspreferHanging

arguments.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#argumentspreferSingleLine

arguments.spaceAround boolean | null

Whether to place spaces around enclosed expressions.

Default: false

See: https://dprint.dev/plugins/typescript/config/#argumentsspaceAround

arguments.trailingCommas TrailingCommas | null

If trailing commas should be used.

Default: "onlyMultiLine"

See: https://dprint.dev/plugins/typescript/config/#argumentstrailingCommas

arrayExpression.preferHanging PreferHanging | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: "never"

See: https://dprint.dev/plugins/typescript/config/#arrayExpressionpreferHanging

arrayExpression.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#arrayExpressionpreferSingleLine

arrayExpression.spaceAround boolean | null

Whether to place spaces around enclosed expressions.

Default: false

See: https://dprint.dev/plugins/typescript/config/#arrayExpressionspaceAround

arrayExpression.trailingCommas TrailingCommas | null

If trailing commas should be used.

Default: "onlyMultiLine"

See: https://dprint.dev/plugins/typescript/config/#arrayExpressiontrailingCommas

arrayPattern.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#arrayPatternpreferHanging

arrayPattern.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#arrayPatternpreferSingleLine

arrayPattern.spaceAround boolean | null

Whether to place spaces around enclosed expressions.

Default: false

See: https://dprint.dev/plugins/typescript/config/#arrayPatternspaceAround

arrayPattern.trailingCommas TrailingCommas | null

If trailing commas should be used.

Default: "onlyMultiLine"

See: https://dprint.dev/plugins/typescript/config/#arrayPatterntrailingCommas

arrowFunction.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#arrowFunctionbracePosition

arrowFunction.useParentheses UseParentheses | null

Whether to use parentheses around a single parameter in an arrow function.

Default: "maintain"

See: https://dprint.dev/plugins/typescript/config/#arrowFunctionuseParentheses

binaryExpression.linePerExpression boolean | null

Whether to force a line per expression when spanning multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#binaryExpressionlinePerExpression

binaryExpression.operatorPosition OperatorPosition | null

Where to place the operator for expressions that span multiple lines.

Default: "nextLine"

See: https://dprint.dev/plugins/typescript/config/#binaryExpressionoperatorPosition

binaryExpression.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#binaryExpressionpreferSingleLine

binaryExpression.spaceSurroundingBitwiseAndArithmeticOperator boolean | null

Whether to surround the operator in a binary expression with spaces.

Default: true

See: https://dprint.dev/plugins/typescript/config/#binaryExpressionspaceSurroundingBitwiseAndArithmeticOperator

bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#bracePosition

catchClause.spaceAround boolean | null

Whether to place spaces around enclosed expressions.

Default: false

See: https://dprint.dev/plugins/typescript/config/#catchClausespaceAround

classDeclaration.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#classDeclarationbracePosition

classExpression.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#classExpressionbracePosition

commentLine.forceSpaceAfterSlashes boolean | null

Forces a space after the double slash in a comment line.

Default: true

See: https://dprint.dev/plugins/typescript/config/#commentLineforceSpaceAfterSlashes

computed.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#computedpreferSingleLine

conditionalExpression.operatorPosition OperatorPosition | null

Where to place the operator for expressions that span multiple lines.

Default: "nextLine"

See: https://dprint.dev/plugins/typescript/config/#conditionalExpressionoperatorPosition

conditionalExpression.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#conditionalExpressionpreferSingleLine

conditionalType.operatorPosition OperatorPosition | null

Where to place the operator for expressions that span multiple lines.

Default: "nextLine"

See: https://dprint.dev/plugins/typescript/config/#conditionalTypeoperatorPosition

conditionalType.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#conditionalTypepreferSingleLine

constructSignature.spaceAfterNewKeyword boolean | null

Whether to add a space after the new keyword in a construct signature.

Default: false

See: https://dprint.dev/plugins/typescript/config/#constructSignaturespaceAfterNewKeyword

constructor.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#constructorbracePosition

constructor.spaceBeforeParentheses boolean | null

Whether to add a space before the parentheses of a constructor.

Default: false

See: https://dprint.dev/plugins/typescript/config/#constructorspaceBeforeParentheses

constructorType.spaceAfterNewKeyword boolean | null

Whether to add a space after the new keyword in a constructor type.

Default: false

See: https://dprint.dev/plugins/typescript/config/#constructorTypespaceAfterNewKeyword

decorators.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#decoratorspreferSingleLine

deno boolean | null

Top level configuration that sets the configuration to what is used in Deno.

Default: false

See: https://dprint.dev/plugins/typescript/config/#deno

doWhileStatement.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#doWhileStatementbracePosition

doWhileStatement.nextControlFlowPosition OperatorPosition | null

Where to place the next control flow within a control flow statement.

Default: "sameLine"

See: https://dprint.dev/plugins/typescript/config/#doWhileStatementnextControlFlowPosition

doWhileStatement.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#doWhileStatementpreferHanging

doWhileStatement.spaceAfterWhileKeyword boolean | null

Whether to add a space after the while keyword in a do while statement.

Default: true

See: https://dprint.dev/plugins/typescript/config/#doWhileStatementspaceAfterWhileKeyword

doWhileStatement.spaceAround boolean | null

Whether to place spaces around enclosed expressions.

Default: false

See: https://dprint.dev/plugins/typescript/config/#doWhileStatementspaceAround

enumDeclaration.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#enumDeclarationbracePosition

enumDeclaration.memberSpacing MemberSpacing | null

How to space the members of an enum.

Default: "maintain"

See: https://dprint.dev/plugins/typescript/config/#enumDeclarationmemberSpacing

enumDeclaration.trailingCommas TrailingCommas | null

If trailing commas should be used.

Default: "onlyMultiLine"

See: https://dprint.dev/plugins/typescript/config/#enumDeclarationtrailingCommas

exportDeclaration.forceMultiLine ForceMultiLine | null

If code import/export specifiers should be forced to be on multiple lines.

Default: "never"

See: https://dprint.dev/plugins/typescript/config/#exportDeclarationforceMultiLine

exportDeclaration.forceSingleLine boolean | null

If code should be forced to be on a single line if able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#exportDeclarationforceSingleLine

exportDeclaration.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#exportDeclarationpreferHanging

exportDeclaration.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#exportDeclarationpreferSingleLine

exportDeclaration.sortNamedExports SortImportDeclarations | null

The kind of sort ordering to use.

Default: "caseInsensitive"

See: https://dprint.dev/plugins/typescript/config/#exportDeclarationsortNamedExports

exportDeclaration.sortTypeOnlyExports SortTypeOnlyExports | null

The kind of sort ordering to use for typed imports and exports.

Default: "none"

See: https://dprint.dev/plugins/typescript/config/#exportDeclarationsortTypeOnlyExports

exportDeclaration.spaceSurroundingNamedExports boolean | null

Whether to add spaces around named exports in an export declaration.

Default: true

See: https://dprint.dev/plugins/typescript/config/#exportDeclarationspaceSurroundingNamedExports

exportDeclaration.trailingCommas TrailingCommas | null

If trailing commas should be used.

Default: "onlyMultiLine"

See: https://dprint.dev/plugins/typescript/config/#exportDeclarationtrailingCommas

extendsClause.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#extendsClausepreferHanging

forInStatement.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#forInStatementbracePosition

forInStatement.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#forInStatementpreferHanging

forInStatement.singleBodyPosition OperatorPosition | null

Where to place the expression of a statement that could possibly be on one line (ex. if (true) console.log(5);).

Default: "maintain"

See: https://dprint.dev/plugins/typescript/config/#forInStatementsingleBodyPosition

forInStatement.spaceAfterForKeyword boolean | null

Whether to add a space after the for keyword in a "for in" statement.

Default: true

See: https://dprint.dev/plugins/typescript/config/#forInStatementspaceAfterForKeyword

forInStatement.spaceAround boolean | null

Whether to place spaces around enclosed expressions.

Default: false

See: https://dprint.dev/plugins/typescript/config/#forInStatementspaceAround

forInStatement.useBraces UseBraces | null

If braces should be used or not.

Default: "whenNotSingleLine"

See: https://dprint.dev/plugins/typescript/config/#forInStatementuseBraces

forOfStatement.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#forOfStatementbracePosition

forOfStatement.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#forOfStatementpreferHanging

forOfStatement.singleBodyPosition OperatorPosition | null

Where to place the expression of a statement that could possibly be on one line (ex. if (true) console.log(5);).

Default: "maintain"

See: https://dprint.dev/plugins/typescript/config/#forOfStatementsingleBodyPosition

forOfStatement.spaceAfterForKeyword boolean | null

Whether to add a space after the for keyword in a "for of" statement.

Default: true

See: https://dprint.dev/plugins/typescript/config/#forOfStatementspaceAfterForKeyword

forOfStatement.spaceAround boolean | null

Whether to place spaces around enclosed expressions.

Default: false

See: https://dprint.dev/plugins/typescript/config/#forOfStatementspaceAround

forOfStatement.useBraces UseBraces | null

If braces should be used or not.

Default: "whenNotSingleLine"

See: https://dprint.dev/plugins/typescript/config/#forOfStatementuseBraces

forStatement.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#forStatementbracePosition

forStatement.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#forStatementpreferHanging

forStatement.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#forStatementpreferSingleLine

forStatement.singleBodyPosition OperatorPosition | null

Where to place the expression of a statement that could possibly be on one line (ex. if (true) console.log(5);).

Default: "maintain"

See: https://dprint.dev/plugins/typescript/config/#forStatementsingleBodyPosition

forStatement.spaceAfterForKeyword boolean | null

Whether to add a space after the for keyword in a "for" statement.

Default: true

See: https://dprint.dev/plugins/typescript/config/#forStatementspaceAfterForKeyword

forStatement.spaceAfterSemiColons boolean | null

Whether to add a space after the semi-colons in a "for" statement.

Default: true

See: https://dprint.dev/plugins/typescript/config/#forStatementspaceAfterSemiColons

forStatement.spaceAround boolean | null

Whether to place spaces around enclosed expressions.

Default: false

See: https://dprint.dev/plugins/typescript/config/#forStatementspaceAround

forStatement.useBraces UseBraces | null

If braces should be used or not.

Default: "whenNotSingleLine"

See: https://dprint.dev/plugins/typescript/config/#forStatementuseBraces

functionDeclaration.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#functionDeclarationbracePosition

functionDeclaration.spaceBeforeParentheses boolean | null

Whether to add a space before the parentheses of a function declaration.

Default: false

See: https://dprint.dev/plugins/typescript/config/#functionDeclarationspaceBeforeParentheses

functionExpression.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#functionExpressionbracePosition

functionExpression.spaceAfterFunctionKeyword boolean | null

Whether to add a space after the function keyword of a function expression.

Default: false

See: https://dprint.dev/plugins/typescript/config/#functionExpressionspaceAfterFunctionKeyword

functionExpression.spaceBeforeParentheses boolean | null

Whether to add a space before the parentheses of a function expression.

Default: false

See: https://dprint.dev/plugins/typescript/config/#functionExpressionspaceBeforeParentheses

getAccessor.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#getAccessorbracePosition

getAccessor.spaceBeforeParentheses boolean | null

Whether to add a space before the parentheses of a get accessor.

Default: false

See: https://dprint.dev/plugins/typescript/config/#getAccessorspaceBeforeParentheses

ifStatement.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#ifStatementbracePosition

ifStatement.nextControlFlowPosition OperatorPosition | null

Where to place the next control flow within a control flow statement.

Default: "sameLine"

See: https://dprint.dev/plugins/typescript/config/#ifStatementnextControlFlowPosition

ifStatement.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#ifStatementpreferHanging

ifStatement.singleBodyPosition OperatorPosition | null

Where to place the expression of a statement that could possibly be on one line (ex. if (true) console.log(5);).

Default: "maintain"

See: https://dprint.dev/plugins/typescript/config/#ifStatementsingleBodyPosition

ifStatement.spaceAfterIfKeyword boolean | null

Whether to add a space after the if keyword in an "if" statement.

Default: true

See: https://dprint.dev/plugins/typescript/config/#ifStatementspaceAfterIfKeyword

ifStatement.spaceAround boolean | null

Whether to place spaces around enclosed expressions.

Default: false

See: https://dprint.dev/plugins/typescript/config/#ifStatementspaceAround

ifStatement.useBraces UseBraces | null

If braces should be used or not.

Default: "whenNotSingleLine"

See: https://dprint.dev/plugins/typescript/config/#ifStatementuseBraces

ignoreFileCommentText string | null

The text to use for a file ignore comment (ex. // dprint-ignore-file).

Default: "dprint-ignore-file"

See: https://dprint.dev/plugins/typescript/config/#ignoreFileCommentText

ignoreNodeCommentText string | null

The text to use for an ignore comment (ex. // dprint-ignore).

Default: "dprint-ignore"

See: https://dprint.dev/plugins/typescript/config/#ignoreNodeCommentText

implementsClause.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#implementsClausepreferHanging

importDeclaration.forceMultiLine ForceMultiLine | null

If code import/export specifiers should be forced to be on multiple lines.

Default: "never"

See: https://dprint.dev/plugins/typescript/config/#importDeclarationforceMultiLine

importDeclaration.forceSingleLine boolean | null

If code should be forced to be on a single line if able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#importDeclarationforceSingleLine

importDeclaration.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#importDeclarationpreferHanging

importDeclaration.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#importDeclarationpreferSingleLine

importDeclaration.sortNamedImports SortImportDeclarations | null

The kind of sort ordering to use.

Default: "caseInsensitive"

See: https://dprint.dev/plugins/typescript/config/#importDeclarationsortNamedImports

importDeclaration.sortTypeOnlyImports SortTypeOnlyExports | null

The kind of sort ordering to use for typed imports and exports.

Default: "none"

See: https://dprint.dev/plugins/typescript/config/#importDeclarationsortTypeOnlyImports

importDeclaration.spaceSurroundingNamedImports boolean | null

Whether to add spaces around named imports in an import declaration.

Default: true

See: https://dprint.dev/plugins/typescript/config/#importDeclarationspaceSurroundingNamedImports

importDeclaration.trailingCommas TrailingCommas | null

If trailing commas should be used.

Default: "onlyMultiLine"

See: https://dprint.dev/plugins/typescript/config/#importDeclarationtrailingCommas

indentWidth integer | null

The number of columns for an indent.

Default: 2

See: https://dprint.dev/plugins/typescript/config/#indentWidth

format=uint32min=0
interfaceDeclaration.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#interfaceDeclarationbracePosition

jsx.bracketPosition OperatorPosition | null

If the end angle bracket of a jsx open element or self closing element should be on the same or next line when the attributes span multiple lines.

Default: "nextLine"

See: https://dprint.dev/plugins/typescript/config/#jsxbracketPosition

jsx.forceNewLinesSurroundingContent boolean | null

Forces newlines surrounding the content of JSX elements.

Default: false

See: https://dprint.dev/plugins/typescript/config/#jsxforceNewLinesSurroundingContent

jsx.multiLineParens MultiLineParens | null

Surrounds the top-most JSX element or fragment in parentheses when it spans multiple lines.

Default: "prefer"

See: https://dprint.dev/plugins/typescript/config/#jsxmultiLineParens

jsx.quoteStyle QuoteStyleKind | null

How to use single or double quotes in JSX attributes.

Default: "preferDouble"

See: https://dprint.dev/plugins/typescript/config/#jsxquoteStyle

jsxAttributes.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#jsxAttributespreferHanging

jsxAttributes.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#jsxAttributespreferSingleLine

jsxElement.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#jsxElementpreferSingleLine

jsxExpressionContainer.spaceSurroundingExpression boolean | null

Whether to add a space surrounding the expression of a JSX container.

Default: false

See: https://dprint.dev/plugins/typescript/config/#jsxExpressionContainerspaceSurroundingExpression

jsxOpeningElement.bracketPosition OperatorPosition | null

If the end angle bracket of a jsx open element or self closing element should be on the same or next line when the attributes span multiple lines.

Default: "nextLine"

See: https://dprint.dev/plugins/typescript/config/#jsxOpeningElementbracketPosition

jsxSelfClosingElement.bracketPosition OperatorPosition | null

If the end angle bracket of a jsx open element or self closing element should be on the same or next line when the attributes span multiple lines.

Default: "nextLine"

See: https://dprint.dev/plugins/typescript/config/#jsxSelfClosingElementbracketPosition

jsxSelfClosingElement.spaceBeforeSlash boolean | null

Whether to add a space before a JSX element's slash when self closing.

Default: true

See: https://dprint.dev/plugins/typescript/config/#jsxSelfClosingElementspaceBeforeSlash

lineWidth integer | null

The width of a line the printer will try to stay under. Note that the printer may exceed this width in certain cases.

Default: 120

See: https://dprint.dev/plugins/typescript/config/#lineWidth

format=uint32min=0
mappedType.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#mappedTypepreferSingleLine

memberExpression.linePerExpression boolean | null

Whether to force a line per expression when spanning multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#memberExpressionlinePerExpression

memberExpression.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#memberExpressionpreferSingleLine

method.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#methodbracePosition

method.spaceBeforeParentheses boolean | null

Whether to add a space before the parentheses of a method.

Default: false

See: https://dprint.dev/plugins/typescript/config/#methodspaceBeforeParentheses

module.sortExportDeclarations SortImportDeclarations | null

The kind of sort ordering to use.

Default: "caseInsensitive"

See: https://dprint.dev/plugins/typescript/config/#modulesortExportDeclarations

module.sortImportDeclarations SortImportDeclarations | null

The kind of sort ordering to use.

Default: "caseInsensitive"

See: https://dprint.dev/plugins/typescript/config/#modulesortImportDeclarations

moduleDeclaration.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#moduleDeclarationbracePosition

newLineKind NewLineKind2 | null

The kind of newline to use.

Default: "lf"

See: https://dprint.dev/plugins/typescript/config/#newLineKind

nextControlFlowPosition OperatorPosition | null

Where to place the next control flow within a control flow statement.

Default: "sameLine"

See: https://dprint.dev/plugins/typescript/config/#nextControlFlowPosition

objectExpression.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#objectExpressionpreferHanging

objectExpression.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#objectExpressionpreferSingleLine

objectExpression.spaceSurroundingProperties boolean | null

Whether to add a space surrounding the properties of a single line object expression.

Default: true

See: https://dprint.dev/plugins/typescript/config/#objectExpressionspaceSurroundingProperties

objectExpression.trailingCommas TrailingCommas | null

If trailing commas should be used.

Default: "onlyMultiLine"

See: https://dprint.dev/plugins/typescript/config/#objectExpressiontrailingCommas

objectPattern.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#objectPatternpreferHanging

objectPattern.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#objectPatternpreferSingleLine

objectPattern.spaceSurroundingProperties boolean | null

Whether to add a space surrounding the properties of a single line object pattern.

Default: true

See: https://dprint.dev/plugins/typescript/config/#objectPatternspaceSurroundingProperties

objectPattern.trailingCommas TrailingCommas | null

If trailing commas should be used.

Default: "onlyMultiLine"

See: https://dprint.dev/plugins/typescript/config/#objectPatterntrailingCommas

operatorPosition OperatorPosition | null

Where to place the operator for expressions that span multiple lines.

Default: "nextLine"

See: https://dprint.dev/plugins/typescript/config/#operatorPosition

parameters.preferHanging PreferHanging | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: "never"

See: https://dprint.dev/plugins/typescript/config/#parameterspreferHanging

parameters.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#parameterspreferSingleLine

parameters.spaceAround boolean | null

Whether to place spaces around enclosed expressions.

Default: false

See: https://dprint.dev/plugins/typescript/config/#parametersspaceAround

parameters.trailingCommas TrailingCommas | null

If trailing commas should be used.

Default: "onlyMultiLine"

See: https://dprint.dev/plugins/typescript/config/#parameterstrailingCommas

parenExpression.spaceAround boolean | null

Whether to place spaces around enclosed expressions.

Default: false

See: https://dprint.dev/plugins/typescript/config/#parenExpressionspaceAround

parentheses.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#parenthesespreferSingleLine

preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#preferHanging

preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#preferSingleLine

quoteProps QuoteProps | null

Change when properties in objects are quoted.

Default: "preserve"

See: https://dprint.dev/plugins/typescript/config/#quoteProps

quoteStyle QuoteStyle | null

How to use single or double quotes.

Default: "alwaysDouble"

See: https://dprint.dev/plugins/typescript/config/#quoteStyle

semiColons SemiColons | null

How semi-colons should be used.

Default: "prefer"

See: https://dprint.dev/plugins/typescript/config/#semiColons

sequenceExpression.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#sequenceExpressionpreferHanging

setAccessor.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#setAccessorbracePosition

setAccessor.spaceBeforeParentheses boolean | null

Whether to add a space before the parentheses of a set accessor.

Default: false

See: https://dprint.dev/plugins/typescript/config/#setAccessorspaceBeforeParentheses

singleBodyPosition OperatorPosition | null

Where to place the expression of a statement that could possibly be on one line (ex. if (true) console.log(5);).

Default: "maintain"

See: https://dprint.dev/plugins/typescript/config/#singleBodyPosition

spaceAround boolean | null

Whether to place spaces around enclosed expressions.

Default: false

See: https://dprint.dev/plugins/typescript/config/#spaceAround

spaceSurroundingProperties boolean | null

Whether to add a space surrounding the properties of single line object-like nodes.

Default: true

See: https://dprint.dev/plugins/typescript/config/#spaceSurroundingProperties

staticBlock.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#staticBlockbracePosition

switchCase.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#switchCasebracePosition

switchStatement.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#switchStatementbracePosition

switchStatement.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#switchStatementpreferHanging

switchStatement.spaceAround boolean | null

Whether to place spaces around enclosed expressions.

Default: false

See: https://dprint.dev/plugins/typescript/config/#switchStatementspaceAround

taggedTemplate.spaceBeforeLiteral boolean | null

Whether to add a space before the literal in a tagged template.

Default: false

See: https://dprint.dev/plugins/typescript/config/#taggedTemplatespaceBeforeLiteral

trailingCommas TrailingCommas | null

If trailing commas should be used.

Default: "onlyMultiLine"

See: https://dprint.dev/plugins/typescript/config/#trailingCommas

tryStatement.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#tryStatementbracePosition

tryStatement.nextControlFlowPosition OperatorPosition | null

Where to place the next control flow within a control flow statement.

Default: "sameLine"

See: https://dprint.dev/plugins/typescript/config/#tryStatementnextControlFlowPosition

tupleType.preferHanging PreferHanging | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: "never"

See: https://dprint.dev/plugins/typescript/config/#tupleTypepreferHanging

tupleType.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#tupleTypepreferSingleLine

tupleType.spaceAround boolean | null

Whether to place spaces around enclosed expressions.

Default: false

See: https://dprint.dev/plugins/typescript/config/#tupleTypespaceAround

tupleType.trailingCommas TrailingCommas | null

If trailing commas should be used.

Default: "onlyMultiLine"

See: https://dprint.dev/plugins/typescript/config/#tupleTypetrailingCommas

typeAnnotation.spaceBeforeColon boolean | null

Whether to add a space before the colon of a type annotation.

Default: false

See: https://dprint.dev/plugins/typescript/config/#typeAnnotationspaceBeforeColon

typeAssertion.spaceBeforeExpression boolean | null

Whether to add a space before the expression in a type assertion.

Default: true

See: https://dprint.dev/plugins/typescript/config/#typeAssertionspaceBeforeExpression

typeLiteral.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#typeLiteralpreferHanging

typeLiteral.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#typeLiteralpreferSingleLine

typeLiteral.separatorKind SeparatorKind | null

The kind of separator to use in type literals.

Default: "semiColon"

See: https://dprint.dev/plugins/typescript/config/#typeLiteralseparatorKind

typeLiteral.separatorKind.multiLine SeparatorKind | null

The kind of separator to use in type literals.

Default: "semiColon"

See: https://dprint.dev/plugins/typescript/config/#typeLiteralseparatorKindmultiLine

typeLiteral.separatorKind.singleLine SeparatorKind | null

The kind of separator to use in type literals.

Default: "semiColon"

See: https://dprint.dev/plugins/typescript/config/#typeLiteralseparatorKindsingleLine

typeLiteral.spaceSurroundingProperties boolean | null

Whether to add a space surrounding the properties of a single line type literal.

Default: true

See: https://dprint.dev/plugins/typescript/config/#typeLiteralspaceSurroundingProperties

typeLiteral.trailingCommas TrailingCommas | null

If trailing commas should be used.

Default: "onlyMultiLine"

See: https://dprint.dev/plugins/typescript/config/#typeLiteraltrailingCommas

typeParameters.preferHanging PreferHanging | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: "never"

See: https://dprint.dev/plugins/typescript/config/#typeParameterspreferHanging

typeParameters.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#typeParameterspreferSingleLine

typeParameters.trailingCommas TrailingCommas | null

If trailing commas should be used.

Default: "onlyMultiLine"

See: https://dprint.dev/plugins/typescript/config/#typeParameterstrailingCommas

unionAndIntersectionType.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#unionAndIntersectionTypepreferHanging

unionAndIntersectionType.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#unionAndIntersectionTypepreferSingleLine

useBraces UseBraces | null

If braces should be used or not.

Default: "whenNotSingleLine"

See: https://dprint.dev/plugins/typescript/config/#useBraces

useTabs boolean | null

Whether to use tabs (true) or spaces (false).

Default: false

See: https://dprint.dev/plugins/typescript/config/#useTabs

variableStatement.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#variableStatementpreferHanging

variableStatement.preferSingleLine boolean | null

If code should revert back from being on multiple lines to being on a single line when able.

Default: false

See: https://dprint.dev/plugins/typescript/config/#variableStatementpreferSingleLine

whileStatement.bracePosition BracePosition | null

Where to place the opening brace.

Default: "sameLineUnlessHanging"

See: https://dprint.dev/plugins/typescript/config/#whileStatementbracePosition

whileStatement.preferHanging boolean | null

Set to prefer hanging indentation when exceeding the line width instead of making code split up on multiple lines.

Default: false

See: https://dprint.dev/plugins/typescript/config/#whileStatementpreferHanging

whileStatement.singleBodyPosition OperatorPosition | null

Where to place the expression of a statement that could possibly be on one line (ex. if (true) console.log(5);).

Default: "maintain"

See: https://dprint.dev/plugins/typescript/config/#whileStatementsingleBodyPosition

whileStatement.spaceAfterWhileKeyword boolean | null

Whether to add a space after the while keyword in a while statement.

Default: true

See: https://dprint.dev/plugins/typescript/config/#whileStatementspaceAfterWhileKeyword

whileStatement.spaceAround boolean | null

Whether to place spaces around enclosed expressions.

Default: false

See: https://dprint.dev/plugins/typescript/config/#whileStatementspaceAround

whileStatement.useBraces UseBraces | null

If braces should be used or not.

Default: "whenNotSingleLine"

See: https://dprint.dev/plugins/typescript/config/#whileStatementuseBraces

PreferHanging string | string | string

See: https://dprint.dev/plugins/typescript/config/

TrailingCommas string | string | string

See: https://dprint.dev/plugins/typescript/config/

BracePosition string | string | string | string

See: https://dprint.dev/plugins/typescript/config/

UseParentheses string | string | string

See: https://dprint.dev/plugins/typescript/config/

OperatorPosition string | string | string

See: https://dprint.dev/plugins/typescript/config/

MemberSpacing string | string | string

See: https://dprint.dev/plugins/typescript/config/

ForceMultiLine string | string

See: https://dprint.dev/plugins/typescript/config/

SortImportDeclarations string | string | string

See: https://dprint.dev/plugins/typescript/config/

SortTypeOnlyExports string | string | string

See: https://dprint.dev/plugins/typescript/config/

UseBraces string | string | string | string

See: https://dprint.dev/plugins/typescript/config/

MultiLineParens string | string | string

See: https://dprint.dev/plugins/typescript/config/

QuoteStyleKind string | string

See: https://dprint.dev/plugins/typescript/config/

NewLineKind2 string | string | string | string

See: https://dprint.dev/plugins/typescript/config/

QuoteProps string | string | string

See: https://dprint.dev/plugins/typescript/config/

QuoteStyle string | string | string | string

See: https://dprint.dev/plugins/typescript/config/

SemiColons string | string | string

See: https://dprint.dev/plugins/typescript/config/

SeparatorKind string | string

See: https://dprint.dev/plugins/typescript/config/

JsonConfig object

Configuration for the dprint JSON plugin.

See: https://dprint.dev/plugins/json/config/

locked boolean | null

Whether the configuration is not allowed to be overridden or extended.

associations array | null

File patterns to associate with this plugin.

array.preferSingleLine boolean | null

If arrays and objects should collapse to a single line if it would be below the line width.

Default: false

See: https://dprint.dev/plugins/json/config/#arraypreferSingleLine

commentLine.forceSpaceAfterSlashes boolean | null

Forces a space after slashes. For example: // comment instead of //comment

Default: true

See: https://dprint.dev/plugins/json/config/#commentLineforceSpaceAfterSlashes

deno boolean | null

Top level configuration that sets the configuration to what is used in Deno.

Default: false

See: https://dprint.dev/plugins/json/config/#deno

ignoreNodeCommentText string | null

The text to use for an ignore comment (ex. // dprint-ignore).

Default: "dprint-ignore"

See: https://dprint.dev/plugins/json/config/#ignoreNodeCommentText

indentWidth integer | null

The number of characters for an indent.

Default: 2

See: https://dprint.dev/plugins/json/config/#indentWidth

format=uint32min=0
jsonTrailingCommaFiles array | null

When trailingCommas is jsonc, treat these files as JSONC and use trailing commas (ex. ["tsconfig.json", ".vscode/settings.json"]).

See: https://dprint.dev/plugins/json/config/#jsonTrailingCommaFiles

lineWidth integer | null

The width of a line the printer will try to stay under. Note that the printer may exceed this width in certain cases.

Default: 120

See: https://dprint.dev/plugins/json/config/#lineWidth

format=uint32min=0
newLineKind NewLineKind3 | null

The kind of newline to use.

Default: "lf"

See: https://dprint.dev/plugins/json/config/#newLineKind

object.preferSingleLine boolean | null

If arrays and objects should collapse to a single line if it would be below the line width.

Default: false

See: https://dprint.dev/plugins/json/config/#objectpreferSingleLine

preferSingleLine boolean | null

If arrays and objects should collapse to a single line if it would be below the line width.

Default: false

See: https://dprint.dev/plugins/json/config/#preferSingleLine

trailingCommas TrailingCommas2 | null

Whether to use trailing commas.

Default: "jsonc"

See: https://dprint.dev/plugins/json/config/#trailingCommas

useTabs boolean | null

Whether to use tabs (true) or spaces (false).

Default: false

See: https://dprint.dev/plugins/json/config/#useTabs

NewLineKind3 string | string | string | string

See: https://dprint.dev/plugins/json/config/

TrailingCommas2 string | string | string | string

See: https://dprint.dev/plugins/json/config/

TomlConfig object

Configuration for the dprint TOML plugin.

See: https://dprint.dev/plugins/toml/config/

locked boolean | null

Whether the configuration is not allowed to be overridden or extended.

associations array | null

File patterns to associate with this plugin.

cargo.applyConventions boolean | null

Whether to apply sorting to a Cargo.toml file.

Default: true

See: https://dprint.dev/plugins/toml/config/#cargoapplyConventions

comment.forceLeadingSpace boolean | null

Whether to force a leading space in a comment.

Default: true

See: https://dprint.dev/plugins/toml/config/#commentforceLeadingSpace

indentWidth integer | null

The number of characters for an indent.

Default: 2

See: https://dprint.dev/plugins/toml/config/#indentWidth

format=uint32min=0
lineWidth integer | null

The width of a line the printer will try to stay under. Note that the printer may exceed this width in certain cases.

Default: 120

See: https://dprint.dev/plugins/toml/config/#lineWidth

format=uint32min=0
newLineKind NewLineKind4 | null

The kind of newline to use.

Default: "lf"

See: https://dprint.dev/plugins/toml/config/#newLineKind

useTabs boolean | null

Whether to use tabs (true) or spaces (false).

Default: false

See: https://dprint.dev/plugins/toml/config/#useTabs

NewLineKind4 string | string | string | string

See: https://dprint.dev/plugins/toml/config/

MarkdownConfig object

Configuration for the dprint Markdown plugin.

See: https://dprint.dev/plugins/markdown/config/

locked boolean | null

Whether the configuration is not allowed to be overridden or extended.

associations array | null

File patterns to associate with this plugin.

deno boolean | null

Top level configuration that sets the configuration to what is used in Deno.

Default: false

See: https://dprint.dev/plugins/markdown/config/#deno

emphasisKind StrongKind | null

The character to use for emphasis/italics.

Default: "underscores"

See: https://dprint.dev/plugins/markdown/config/#emphasisKind

headingKind HeadingKind | null

The style of heading to use for level 1 and level 2 headings. Level 3 and higher always use ATX headings.

Default: "atx"

See: https://dprint.dev/plugins/markdown/config/#headingKind

ignoreDirective string | null

The text to use for an ignore directive (ex. <!-- dprint-ignore -->).

Default: "dprint-ignore"

See: https://dprint.dev/plugins/markdown/config/#ignoreDirective

ignoreEndDirective string | null

The text to use for an ignore end directive (ex. <!-- dprint-ignore-end -->).

Default: "dprint-ignore-end"

See: https://dprint.dev/plugins/markdown/config/#ignoreEndDirective

ignoreFileDirective string | null

The text to use for an ignore file directive (ex. <!-- dprint-ignore-file -->).

Default: "dprint-ignore-file"

See: https://dprint.dev/plugins/markdown/config/#ignoreFileDirective

ignoreStartDirective string | null

The text to use for an ignore start directive (ex. <!-- dprint-ignore-start -->).

Default: "dprint-ignore-start"

See: https://dprint.dev/plugins/markdown/config/#ignoreStartDirective

lineWidth integer | null

The width of a line the printer will try to stay under. Note that the printer may exceed this width in certain cases.

Default: 80

See: https://dprint.dev/plugins/markdown/config/#lineWidth

format=uint32min=0
newLineKind NewLineKind5 | null

The kind of newline to use.

Default: "lf"

See: https://dprint.dev/plugins/markdown/config/#newLineKind

strongKind StrongKind | null

The character to use for strong emphasis/bold.

Default: "asterisks"

See: https://dprint.dev/plugins/markdown/config/#strongKind

tags Record<string, string>

Custom tag to file extension mappings for formatting code blocks. For example: { "markdown": "md" }

See: https://dprint.dev/plugins/markdown/config/#tags

textWrap TextWrap | null

Text wrapping possibilities.

Default: "maintain"

See: https://dprint.dev/plugins/markdown/config/#textWrap

unorderedListKind UnorderedListKind | null

The character to use for unordered lists.

Default: "dashes"

See: https://dprint.dev/plugins/markdown/config/#unorderedListKind

StrongKind string | string

See: https://dprint.dev/plugins/markdown/config/

HeadingKind string | string

See: https://dprint.dev/plugins/markdown/config/

NewLineKind5 string | string | string | string

See: https://dprint.dev/plugins/markdown/config/

TextWrap string | string | string

See: https://dprint.dev/plugins/markdown/config/

UnorderedListKind string | string

See: https://dprint.dev/plugins/markdown/config/

PluginConfig object

Configuration for a dprint plugin not covered by the typed plugin structs.

Known plugins (typescript, json, toml, markdown) have dedicated typed structs. This catch-all is used for any other plugin name.

locked boolean | null

Prevent properties in this plugin section from being overridden by extended configurations.

associations array | null

File patterns to associate with this plugin.

Examples: ["**/*.myconfig",".myconfigrc"]