@yaegassy/coc-ruff

{
  "enum": [
    "onType",
    "onSave"
  ],
  "type": [
    "string",
    null
  ],
  "scope": "window",
  "default": null,
  "description": "Run Ruff on every keystroke (`onType`) or on save (`onSave`).",
  "enumDescriptions": [
    "Run Ruff on every keystroke.",
    "Run Ruff on save."
  ]
}

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "scope": "resource",
  "default": [],
  "description": "Additional command-line arguments to pass to `ruff check`, e.g., `\"args\": [\"--config=/path/to/pyproject.toml\"]`. Supports a subset of Ruff's command-line arguments, ignoring those that are required to operate the LSP, like `--force-exclude` and `--verbose`."
}

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "scope": "resource",
  "default": [],
  "description": "Path to a custom `ruff` executable, e.g., `[\"/path/to/ruff\"]`."
}

{
  "type": "boolean",
  "default": true,
  "description": "Enable coc-ruff extension"
}

{
  "type": "boolean",
  "scope": "window",
  "default": true,
  "description": "Whether to register Ruff as capable of handling `source.fixAll` actions."
}

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "scope": "resource",
  "default": null,
  "description": "Set paths for the linter and formatter to ignore. See [the documentation](https://docs.astral.sh/ruff/settings/#lint_exclude) for more details. This setting is used only by the native server."
}

{
  "type": "string",
  "scope": "window",
  "default": null,
  "markdownDescription": "Path to the log file for the language server.\n\n**This setting is used only by the native server.**"
}

{
  "enum": [
    "onType",
    "onSave"
  ],
  "type": "string",
  "scope": "window",
  "default": "onType",
  "description": "Run Ruff on every keystroke (`onType`) or on save (`onSave`).",
  "enumDescriptions": [
    "Run Ruff on every keystroke.",
    "Run Ruff on save."
  ]
}

{
  "enum": [
    "error",
    "warning",
    "info",
    "debug",
    "trace"
  ],
  "type": "string",
  "scope": "window",
  "default": null,
  "markdownDescription": "Controls the log level of the language server.\n\n**This setting is used only by the native server.**"
}

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "scope": "resource",
  "default": [],
  "description": "Additional command-line arguments to pass to `ruff check`, e.g., `\"args\": [\"--config=/path/to/pyproject.toml\"]`. Supports a subset of Ruff's command-line arguments, ignoring those that are required to operate the LSP, like `--force-exclude` and `--verbose`."
}

{
  "type": [
    "integer",
    "null"
  ],
  "scope": "resource",
  "default": null,
  "description": "Set the [line length](https://docs.astral.sh/ruff/settings/#line-length) used by the formatter and linter. Must be greater than 0 and less than or equal to 320. This setting is used only by the native server."
}

{
  "type": "string",
  "default": "",
  "description": "Custom path to the ruff-lsp command. If not set, the `ruff-lsp` command found in the current Python environment or venv environment will be used."
}

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "scope": "resource",
  "default": [],
  "description": "Additional command-line arguments to pass to `ruff format`, e.g., `\"args\": [\"--config=/path/to/pyproject.toml\"]`. Supports a subset of Ruff's command-line arguments, ignoring those that are required to operate the LSP, like `--force-exclude` and `--verbose`."
}

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "scope": "window",
  "default": [],
  "description": "When set to a path to python executable, extension will use that to launch the server and any subprocess."
}

{
  "type": "boolean",
  "scope": "window",
  "default": true,
  "markdownDescription": "Whether to enable linting. Set to `false` to use Ruff exclusively as a formatter."
}

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "scope": "resource",
  "default": null,
  "description": "Set rule codes to disable. See [the documentation](https://docs.astral.sh/ruff/settings/#lint_ignore) for more details. This setting is used only by the native server."
}

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "scope": "resource",
  "default": null,
  "description": "Set rule codes to enable. Use `ALL` to enable all rules. See [the documentation](https://docs.astral.sh/ruff/settings/#lint_select) for more details. This setting is used only by the native server."
}

{
  "type": "boolean",
  "default": false,
  "description": "Disable hover only."
}

{
  "type": "boolean",
  "scope": "resource",
  "default": null,
  "description": "Enable [preview mode](https://docs.astral.sh/ruff/settings/#lint_preview) for the linter; enables unstable rules and fixes. This setting is used only by the native server."
}

{
  "type": "boolean",
  "default": true,
  "description": "Use the integrated Rust-based language server, available now in Beta."
}

{
  "enum": [
    "off",
    "messages",
    "verbose"
  ],
  "type": "string",
  "default": "off",
  "description": "Traces the communication between coc.nvim and the ruff-lsp."
}

{
  "type": "boolean",
  "default": false,
  "description": "Turns auto fix on save on or off."
}

{
  "type": "boolean",
  "scope": "resource",
  "default": null,
  "description": "Enable [preview mode](https://docs.astral.sh/ruff/settings/#format_preview) for the formatter; enables unstable formatting. This setting is used only by the native server."
}

{
  "enum": [
    "fromEnvironment",
    "useBundled"
  ],
  "type": "string",
  "scope": "window",
  "default": "fromEnvironment",
  "description": "Strategy for loading the `ruff` executable. `fromEnvironment` picks up Ruff from the environment, falling back to the bundled version if needed. `useBundled` uses the version bundled with the extension.",
  "enumDescriptions": [
    "Use `ruff` from environment, fallback to bundled version only if `ruff` not available in the environment.",
    "Always use the bundled version of `ruff`."
  ]
}

{
  "type": "boolean",
  "scope": "window",
  "default": true,
  "description": "Whether to register Ruff as capable of handling `source.organizeImports` actions."
}

{
  "type": "string",
  "default": "",
  "description": "Custom path for the `ruff` binary when using the native server. If no value is set, the `ruff` command will be detected from the runtime environment."
}

{
  "type": "boolean",
  "scope": "window",
  "default": true,
  "description": "Whether to show syntax error diagnostics."
}

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "scope": "resource",
  "default": null,
  "description": "Enable additional rule codes on top of existing configuration, instead of overriding it. Use `ALL` to enable all rules. This setting is used only by the native server."
}

{
  "enum": [
    "off",
    "onError",
    "onWarning",
    "always"
  ],
  "type": "string",
  "scope": "machine",
  "default": "off",
  "enumDescriptions": [
    "All notifications are turned off, any errors or warning are still available in the logs.",
    "Notifications are shown only in the case of an error.",
    "Notifications are shown for errors and warnings.",
    "Notifications are show for anything that the server chooses to show."
  ],
  "markdownDescription": "Controls when notifications are shown by this extension."
}

{
  "type": "string",
  "default": "",
  "description": "Python 3.x path (Absolute path) to be used for built-in install."
}

{
  "type": "boolean",
  "default": true,
  "description": "Automatically detects the ruff command in the execution environment and sets `ruff.path`."
}

{
  "type": "boolean",
  "scope": "window",
  "default": true,
  "markdownDescription": "Whether to ignore files that are inferred to be part of the Python standard library."
}

{
  "enum": [
    "editorFirst",
    "filesystemFirst",
    "editorOnly"
  ],
  "type": "string",
  "scope": "resource",
  "default": "editorFirst",
  "description": "The preferred method of resolving configuration in the editor with local configuration froml `.toml` files. This setting is used only by the native server.",
  "enumDescriptions": [
    "The default strategy - configuration set in the editor takes priority over configuration set in `.toml` files.",
    "An alternative strategy - configuration set in `.toml` files takes priority over configuration set in the editor.",
    "An alternative strategy - configuration set in `.toml` files is ignored entirely."
  ]
}

{
  "type": "boolean",
  "default": false,
  "description": "Disable document formatting only."
}

{
  "type": "boolean",
  "scope": "machine",
  "default": false,
  "markdownDescription": "Controls whether Ruff registers as capable of code formatting. The Ruff formatter is in an alpha state during which formatting may change at any time."
}

{
  "type": "boolean",
  "scope": "window",
  "default": true,
  "description": "Whether to display Quick Fix actions to autofix violations."
}

{
  "type": "boolean",
  "scope": "window",
  "default": true,
  "description": "Whether to display Quick Fix actions to disable rules via `noqa` suppression comments."
}

{
  "type": "boolean",
  "default": false,
  "description": "Whether to display the code action for open the Ruff rule documentation web page included in the diagnostic information."
}