tombi.schema.json

{
  "$id": "https://json.schemastore.org/tombi.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Tombi",
  "description": "**Tombi** (鳶) is a toolkit for TOML; providing a formatter/linter and language server.\n See the [GitHub repository](https://github.com/tombi-toml/tombi) for more information.",
  "type": "object",
  "properties": {
    "format": {
      "title": "Formatter options.",
      "anyOf": [
        {
          "$ref": "#/definitions/FormatOptions"
        },
        {
          "type": "null"
        }
      ]
    },
    "toml-version": {
      "title": "TOML version.",
      "description": "TOML version to use if not specified in the schema.",
      "anyOf": [
        {
          "$ref": "#/definitions/TomlVersion"
        },
        {
          "type": "null"
        }
      ],
      "default": "v1.0.0"
    },
    "lint": {
      "title": "Linter options.",
      "anyOf": [
        {
          "$ref": "#/definitions/LintOptions"
        },
        {
          "type": "null"
        }
      ]
    },
    "server": {
      "title": "Language server options.",
      "anyOf": [
        {
          "$ref": "#/definitions/ServerOptions"
        },
        {
          "type": "null"
        }
      ]
    },
    "schema": {
      "title": "Schema options.",
      "anyOf": [
        {
          "$ref": "#/definitions/SchemaOptions"
        },
        {
          "type": "null"
        }
      ]
    },
    "schemas": {
      "title": "Schema catalog items.",
      "type": ["array", "null"],
      "items": {
        "$ref": "#/definitions/SchemaCatalogItem"
      }
    }
  },
  "additionalProperties": false,
  "x-tombi-toml-version": "v1.1.0-preview",
  "definitions": {
    "TomlVersion": {
      "title": "TOML version.",
      "type": "string",
      "enum": ["v1.0.0", "v1.1.0-preview"]
    },
    "FormatOptions": {
      "title": "Formatter options.",
      "description": "To avoid needless discussion of formatting rules,\n we do not currently have a configuration item for formatting.",
      "type": "object",
      "additionalProperties": false
    },
    "LintOptions": {
      "type": "object",
      "additionalProperties": false
    },
    "ServerOptions": {
      "title": "Language Server options.",
      "type": "object",
      "properties": {
        "hover": {
          "title": "Hover Feature options.",
          "anyOf": [
            {
              "$ref": "#/definitions/ServerHover"
            },
            {
              "type": "null"
            }
          ]
        },
        "completion": {
          "title": "Completion Feature options.",
          "anyOf": [
            {
              "$ref": "#/definitions/ServerCompletion"
            },
            {
              "type": "null"
            }
          ]
        },
        "formatting": {
          "title": "Formatting Feature options.",
          "anyOf": [
            {
              "$ref": "#/definitions/ServerFormatting"
            },
            {
              "type": "null"
            }
          ]
        },
        "diagnostics": {
          "title": "Diagnostics Feature options.",
          "anyOf": [
            {
              "$ref": "#/definitions/ServerDiagnostics"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "ServerHover": {
      "type": "object",
      "properties": {
        "enabled": {
          "title": "Enable hover feature.",
          "description": "Whether to enable hover.",
          "anyOf": [
            {
              "$ref": "#/definitions/Enabled"
            },
            {
              "type": "null"
            }
          ],
          "default": true
        }
      },
      "additionalProperties": false
    },
    "Enabled": {
      "type": "boolean"
    },
    "ServerCompletion": {
      "type": "object",
      "properties": {
        "enabled": {
          "title": "Enable completion feature.",
          "description": "Whether to enable completion.\n\n **WARNING**: 🚧 This feature is experimental 🚧",
          "anyOf": [
            {
              "$ref": "#/definitions/Enabled"
            },
            {
              "type": "null"
            }
          ],
          "default": true
        }
      },
      "additionalProperties": false
    },
    "ServerFormatting": {
      "type": "object",
      "properties": {
        "enabled": {
          "title": "Enable formatting feature.",
          "description": "Whether to enable formatting.",
          "anyOf": [
            {
              "$ref": "#/definitions/Enabled"
            },
            {
              "type": "null"
            }
          ],
          "default": true
        }
      },
      "additionalProperties": false
    },
    "ServerDiagnostics": {
      "type": "object",
      "properties": {
        "enabled": {
          "title": "Enable diagnostics feature.",
          "description": "Whether to enable diagnostics.",
          "anyOf": [
            {
              "$ref": "#/definitions/Enabled"
            },
            {
              "type": "null"
            }
          ],
          "default": true
        }
      },
      "additionalProperties": false
    },
    "SchemaOptions": {
      "type": "object",
      "properties": {
        "enabled": {
          "title": "Enable or disable the schema.",
          "anyOf": [
            {
              "$ref": "#/definitions/Enabled"
            },
            {
              "type": "null"
            }
          ],
          "default": true
        },
        "catalog": {
          "title": "Schema catalog options.",
          "anyOf": [
            {
              "$ref": "#/definitions/SchemaCatalog"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "SchemaCatalog": {
      "type": "object",
      "properties": {
        "path": {
          "title": "The schema catalog path or url.",
          "description": "The catalog is evaluated after the schemas specified by [[schemas]].\n\n You can specify multiple catalogs by making it an array.\n If you specify an array, the catalogs are searched in order of priority starting from the first catalog.\n If you want to disable the default catalog, specify an empty array.",
          "anyOf": [
            {
              "$ref": "#/definitions/OneOrMany_for_SchemaCatalogPath"
            },
            {
              "type": "null"
            }
          ],
          "default": "https://www.schemastore.org/api/json/catalog.json"
        }
      },
      "additionalProperties": false
    },
    "OneOrMany_for_SchemaCatalogPath": {
      "anyOf": [
        {
          "$ref": "#/definitions/SchemaCatalogPath"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SchemaCatalogPath"
          }
        }
      ]
    },
    "SchemaCatalogPath": {
      "description": "Generic value that can be either single or multiple",
      "type": "string"
    },
    "SchemaCatalogItem": {
      "anyOf": [
        {
          "$ref": "#/definitions/RootSchemaCatalogItem"
        },
        {
          "$ref": "#/definitions/SubSchemaCatalogItem"
        }
      ]
    },
    "RootSchemaCatalogItem": {
      "type": "object",
      "properties": {
        "toml-version": {
          "title": "The TOML version that the schema is available.",
          "anyOf": [
            {
              "$ref": "#/definitions/TomlVersion"
            },
            {
              "type": "null"
            }
          ]
        },
        "path": {
          "title": "The schema path.",
          "type": "string"
        },
        "include": {
          "title": "The file match pattern of the schema.",
          "description": "The file match pattern to include the target to apply the schema.\n Supports glob pattern.",
          "type": "array",
          "items": {
            "type": "string"
          },
          "minItems": 1
        }
      },
      "additionalProperties": false,
      "required": ["path", "include"]
    },
    "SubSchemaCatalogItem": {
      "type": "object",
      "properties": {
        "path": {
          "title": "The schema path.",
          "type": "string"
        },
        "include": {
          "title": "The file match pattern of the schema.",
          "description": "The file match pattern to include the target to apply the schema.\n Supports glob pattern.",
          "type": "array",
          "items": {
            "type": "string"
          },
          "minItems": 1
        },
        "root-keys": {
          "title": "The key to apply the schema as the root.",
          "type": ["string", "null"],
          "minLength": 1
        }
      },
      "additionalProperties": false,
      "required": ["path", "include"]
    }
  }
}