Type object
File match .taplo.toml taplo.toml
Schema URL https://catalog.lintel.tools/schemas/schemastore/taplo/latest.json
Source https://www.schemastore.org/taplo.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

exclude array | null

Files to exclude (ignore).

A list of Unix-like glob path patterns. Globstars (**) are supported.

Relative paths are not relative to the configuration file, but rather depends on the tool using the configuration.

This has priority over include.

formatting OptionsIncomplete | null

Formatting options.

include array | null

Files to include.

A list of Unix-like glob path patterns. Globstars (**) are supported.

Relative paths are not relative to the configuration file, but rather depends on the tool using the configuration.

Omitting this property includes all files, however an empty array will include none.

plugins Record<string, object>
rule Rule[]

Rules are used to override configurations by path and keys.

schema SchemaOptions | null

Schema validation options.

Definitions

OptionsIncomplete object

All the formatting options.

align_comments boolean | null

Align consecutive comments after entries and items vertically.

This applies to comments that are after entries or array items.

align_entries boolean | null

Align entries vertically.

Entries that have table headers, comments, or blank lines between them are not aligned.

align_single_comments boolean | null

If align_comments is true, apply the alignment in cases where there's only one comment.

allowed_blank_lines integer | null

The maximum amount of consecutive blank lines allowed.

min=0.0
array_auto_collapse boolean | null

Automatically collapse arrays if they fit in one line.

The array won't be collapsed if it contains a comment.

array_auto_expand boolean | null

Automatically expand arrays to multiple lines once they exceed the configured column_width.

array_trailing_comma boolean | null

Put trailing commas for multiline arrays.

column_width integer | null

Target maximum column width after which arrays are expanded into new lines.

This is best-effort and might not be accurate.

min=0.0
compact_arrays boolean | null

Omit whitespace padding inside single-line arrays.

compact_entries boolean | null

Omit whitespace around =.

compact_inline_tables boolean | null

Omit whitespace padding inside inline tables.

crlf boolean | null

Use CRLF line endings

indent_entries boolean | null

Indent entries under tables.

indent_string string | null

Indentation to use, should be tabs or spaces but technically could be anything.

indent_tables boolean | null

Indent subtables if they come in order.

inline_table_expand boolean | null

Expand values (e.g.) inside inline tables where possible.

reorder_arrays boolean | null

Alphabetically reorder array values that are not separated by blank lines.

reorder_keys boolean | null

Alphabetically reorder keys that are not separated by blank lines.

trailing_newline boolean | null

Add trailing newline to the source.

Plugin object

A plugin to extend Taplo's capabilities.

settings

Optional settings for the plugin.

Default: null
Rule object

A rule to override options by either name or file.

exclude array | null

Files that are excluded from this rule.

A list of Unix-like glob path patterns.

Relative paths are not relative to the configuration file, but rather depends on the tool using the configuration.

This has priority over include.

formatting OptionsIncomplete | null

Formatting options.

include array | null

Files this rule is valid for.

A list of Unix-like glob path patterns.

Relative paths are not relative to the configuration file, but rather depends on the tool using the configuration.

Omitting this property includes all files, however an empty array will include none.

keys array | null

Keys the rule is valid for in a document.

A list of Unix-like glob dotted key patterns.

This allows enabling the rule for specific paths in the document.

For example:

  • package.metadata will enable the rule for everything inside the package.metadata table, including itself.

If omitted, the rule will always be valid for all keys.

name string | null

The name of the rule.

Used in taplo::<name> comments.

schema SchemaOptions | null

Schema validation options.

SchemaOptions object

Options for schema validation and completion.

Schemas in rules with defined keys are ignored.

enabled boolean | null

Whether the schema should be enabled or not.

Defaults to true if omitted.

path string | null

A local file path to the schema, overrides url if set.

URLs are also accepted here, but it's not a guarantee and might change in newer releases. Please use the url field instead whenever possible.

url string | null

A full absolute URL to the schema.

The url of the schema, supported schemes are http, https, file and taplo.

format=uri