Configuration

Learn how to configure Tombi using the tombi.toml configuration file.

Configuration File

Tombi uses a TOML configuration file named tombi.toml. Also, we supports [tool.tombi] in pyproject.toml.

Search Priority

  1. tombi.toml in the current directory
  2. [tool.tombi] in pyproject.toml in the current directory
  3. ...search parent directory recursively
  4. $XDG_CONFIG_HOME/tombi/config.toml
  5. ~/.config/tombi/config.toml
  6. ~/Library/Application Support/tombi/config.toml (macOS), %APPDATA%\tombi\config.toml (Windows)
  7. /etc/tombi/config.toml (Linux)

Full Structure

toml-version = "1.0.0"

[files]
include = ["**/*.toml"]
exclude = []

[format]

[lint]
[lint.rules]
dotted-keys-out-of-order = "warn"
key-empty = "warn"
tables-out-of-order = "warn"

[lsp]
code-action.enabled = true
completion.enabled = true
diagnostics.enabled = true
document-link.enabled = true
formatting.enabled = true
goto-declaration.enabled = true
goto-definition.enabled = true
goto-type-definition.enabled = true
hover.enabled = true

[schema]
enabled = true
strict = true
catalog = {
  paths = [
    "tombi:///json/catalog.json",
    "https://json.schemastore.org/api/json/catalog.json",
  ],
}

# Root Schema
[[schemas]]
toml-version = "1.0.0"
path = "https://example.com/schema.json"
include = ["example.toml"]

# Sub Schema
[[schemas]]
root = "tool.taskipy"
path = "schemas/partial-taskipy.schema.json"
include = ["pyproject.toml"]
← Code ActionJSON Schema →