Skip to content

Commit

Permalink
chore(build): auto-generate vimdoc, schemas and annotations
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Jul 17, 2024
1 parent 0406095 commit c282e6c
Show file tree
Hide file tree
Showing 3 changed files with 105 additions and 40 deletions.
16 changes: 8 additions & 8 deletions schemas/dartls.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@
},
"dart.dapLogFile": {
"default": null,
"markdownDescription": "The path to a log file for communication with the DAP debug adapters. This is useful when trying to diagnose issues with debugging such as missed breakpoints. Use `${workspaceName}` to insert the name of the current workspace in the file path.",
"markdownDescription": "The path to a log file for communication with the DAP debug adapters. This is useful when trying to diagnose issues with debugging such as missed breakpoints. Use `${name}` in the log file name to insert the Debug Session name to prevent concurrent debug sessions overwriting each others logs. Use `${workspaceName}` to insert the name of the current workspace in the file path. Use `${kind}` to insert a description of the kind of debug session ('dart', 'dart_test', 'flutter' etc.).",
"scope": "machine-overridable",
"type": [
"null",
Expand All @@ -269,7 +269,7 @@
},
"dart.dartTestLogFile": {
"default": null,
"markdownDescription": "The path to a log file for Dart test runs. This is useful when trying to diagnose issues with unit test executions. Use `${name}` in the log file name to insert the Debug Session name to prevent concurrent debug sessions overwriting each others logs. Use `${workspaceName}` to insert the name of the current workspace in the file path.",
"markdownDescription": "**LEGACY SETTING: Only applies when using the legacy debug adapters.**\n\nThe path to a log file for Dart test runs. This is useful when trying to diagnose issues with unit test executions. Use `${name}` in the log file name to insert the Debug Session name to prevent concurrent debug sessions overwriting each others logs. Use `${workspaceName}` to insert the name of the current workspace in the file path.",
"scope": "machine-overridable",
"type": [
"null",
Expand Down Expand Up @@ -422,7 +422,7 @@
},
"dart.devToolsLogFile": {
"default": null,
"description": "The path to a low-traffic log file for the Dart DevTools service.",
"description": "The path to a low-traffic log file for the Dart DevTools service. Use `${workspaceName}` to insert the name of the current workspace in the file path.",
"scope": "machine-overridable",
"type": [
"null",
Expand Down Expand Up @@ -530,7 +530,7 @@
},
"dart.extensionLogFile": {
"default": null,
"description": "The path to a low-traffic log file for basic extension and editor issues.",
"description": "The path to a low-traffic log file for basic extension and editor issues. Use `${workspaceName}` to insert the name of the current workspace in the file path.",
"scope": "machine-overridable",
"type": [
"null",
Expand Down Expand Up @@ -700,7 +700,7 @@
},
"dart.flutterRunLogFile": {
"default": null,
"markdownDescription": "The path to a log file for `flutter run`, which is used to launch Flutter apps from VS Code. This is useful when trying to diagnose issues with apps launching (or failing to) on simulators and devices. Use `${name}` in the log file name to insert the Debug Session name to prevent concurrent debug sessions overwriting each others logs. Use `${workspaceName}` to insert the name of the current workspace in the file path.",
"markdownDescription": "**LEGACY SETTING: Only applies when using the legacy debug adapters.**\n\nThe path to a log file for `flutter run`, which is used to launch Flutter apps from VS Code. This is useful when trying to diagnose issues with apps launching (or failing to) on simulators and devices. Use `${name}` in the log file name to insert the Debug Session name to prevent concurrent debug sessions overwriting each others logs. Use `${workspaceName}` to insert the name of the current workspace in the file path.",
"scope": "machine-overridable",
"type": [
"null",
Expand Down Expand Up @@ -779,7 +779,7 @@
},
"dart.flutterTestLogFile": {
"default": null,
"markdownDescription": "The path to a log file for `flutter test`, which is used to run unit tests from VS Code. This is useful when trying to diagnose issues with unit test executions. Use `${name}` in the log file name to insert the Debug Session name to prevent concurrent debug sessions overwriting each others logs. Use `${workspaceName}` to insert the name of the current workspace in the file path.",
"markdownDescription": "**LEGACY SETTING: Only applies when using the legacy debug adapters.**\n\nThe path to a log file for `flutter test`, which is used to run unit tests from VS Code. This is useful when trying to diagnose issues with unit test executions. Use `${name}` in the log file name to insert the Debug Session name to prevent concurrent debug sessions overwriting each others logs. Use `${workspaceName}` to insert the name of the current workspace in the file path.",
"scope": "machine-overridable",
"type": [
"null",
Expand Down Expand Up @@ -1223,7 +1223,7 @@
},
"dart.vmServiceLogFile": {
"default": null,
"markdownDescription": "The path to a log file for communication between Dart Code and the VM service. This is useful when trying to diagnose issues with debugging such as missed breakpoints. Use `${name}` in the log file name to insert the Debug Session name to prevent concurrent debug sessions overwriting each others logs. Use `${workspaceName}` to insert the name of the current workspace in the file path.",
"markdownDescription": "**LEGACY SETTING: Only applies when using the legacy debug adapters.**\n\nThe path to a log file for communication between Dart Code and the VM service. This is useful when trying to diagnose issues with debugging such as missed breakpoints. Use `${name}` in the log file name to insert the Debug Session name to prevent concurrent debug sessions overwriting each others logs. Use `${workspaceName}` to insert the name of the current workspace in the file path.",
"scope": "machine-overridable",
"type": [
"null",
Expand All @@ -1244,7 +1244,7 @@
},
"dart.webDaemonLogFile": {
"default": null,
"markdownDescription": "The path to a log file for communication between Dart Code and the webdev daemon. This is useful when trying to diagnose issues with launching web apps. Use `${name`} in the log file name to prevent concurrent debug sessions overwriting each others logs. Use `${workspaceName}` to insert the name of the current workspace in the file path.",
"markdownDescription": "**LEGACY SETTING: Only applies when using the legacy debug adapters.**\n\nThe path to a log file for communication between Dart Code and the webdev daemon. This is useful when trying to diagnose issues with launching web apps. Use `${name}` in the log file name to insert the Debug Session name to prevent concurrent debug sessions overwriting each others logs. Use `${workspaceName}` to insert the name of the current workspace in the file path.",
"scope": "machine-overridable",
"type": [
"null",
Expand Down
47 changes: 33 additions & 14 deletions schemas/ruff_lsp.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"type": "string"
},
"markdownDeprecationMessage": "**Deprecated**: Please use `#ruff.lint.args` instead.",
"markdownDescription": "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`. This setting is not supported by the native server.",
"markdownDescription": "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`.\n\n**This setting is not supported by the native server.**",
"scope": "resource",
"type": "array"
},
Expand Down Expand Up @@ -47,7 +47,7 @@
},
"ruff.configuration": {
"default": null,
"markdownDescription": "Path to a `ruff.toml` or `pyproject.toml` file to use for configuration. By default, Ruff will discover configuration for each project from the filesystem, mirroring the behavior of the Ruff CLI. This setting is used only by the native server.",
"markdownDescription": "Path to a `ruff.toml` or `pyproject.toml` file to use for configuration. By default, Ruff will discover configuration for each project from the filesystem, mirroring the behavior of the Ruff CLI.\n\n**This setting is used only by the native server.**",
"scope": "window",
"type": "string"
},
Expand All @@ -63,7 +63,7 @@
"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."
],
"markdownDescription": "The preferred method of resolving configuration in the editor with local configuration froml `.toml` files. This setting is used only by the native server.",
"markdownDescription": "The preferred method of resolving configuration in the editor with local configuration froml `.toml` files.\n\n**This setting is used only by the native server.**",
"scope": "resource",
"type": "string"
},
Expand All @@ -86,7 +86,7 @@
"items": {
"type": "string"
},
"markdownDescription": "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.",
"markdownDescription": "Set paths for the linter and formatter to ignore. See [the documentation](https://docs.astral.sh/ruff/settings/#lint_exclude) for more details.\n\n**This setting is used only by the native server.**",
"scope": "resource",
"type": "array"
},
Expand All @@ -101,13 +101,13 @@
"items": {
"type": "string"
},
"markdownDescription": "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`. This setting is not supported by the native server.",
"markdownDescription": "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`.\n\n**This setting is not supported by the native server.**",
"scope": "resource",
"type": "array"
},
"ruff.format.preview": {
"default": null,
"markdownDescription": "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.",
"markdownDescription": "Enable [preview mode](https://docs.astral.sh/ruff/settings/#format_preview) for the formatter; enables unstable formatting.\n\n**This setting is used only by the native server.**",
"scope": "resource",
"type": "boolean"
},
Expand Down Expand Up @@ -142,7 +142,7 @@
},
"ruff.lineLength": {
"default": null,
"markdownDescription": "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.",
"markdownDescription": "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.\n\n**This setting is used only by the native server.**",
"maximum": 320,
"minimum": 1,
"scope": "resource",
Expand All @@ -156,7 +156,7 @@
"items": {
"type": "string"
},
"markdownDescription": "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`. This setting is not supported by the native server.",
"markdownDescription": "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`.\n\n**This setting is not supported by the native server.**",
"scope": "resource",
"type": "array"
},
Expand All @@ -171,7 +171,7 @@
"items": {
"type": "string"
},
"markdownDescription": "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.",
"markdownDescription": "Enable additional rule codes on top of existing configuration, instead of overriding it. Use `ALL` to enable all rules.\n\n**This setting is used only by the native server.**",
"scope": "resource",
"type": "array"
},
Expand All @@ -180,13 +180,13 @@
"items": {
"type": "string"
},
"markdownDescription": "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.",
"markdownDescription": "Set rule codes to disable. See [the documentation](https://docs.astral.sh/ruff/settings/#lint_ignore) for more details.\n\n**This setting is used only by the native server.**",
"scope": "resource",
"type": "array"
},
"ruff.lint.preview": {
"default": null,
"markdownDescription": "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.",
"markdownDescription": "Enable [preview mode](https://docs.astral.sh/ruff/settings/#lint_preview) for the linter; enables unstable rules and fixes.\n\n**This setting is used only by the native server.**",
"scope": "resource",
"type": "boolean"
},
Expand All @@ -200,7 +200,7 @@
"Run Ruff on every keystroke.",
"Run Ruff on save."
],
"markdownDescription": "Run Ruff on every keystroke (`onType`) or on save (`onSave`). This setting is not supported by the native server.",
"markdownDescription": "Run Ruff on every keystroke (`onType`) or on save (`onSave`).\n\n**This setting is not supported by the native server.**",
"scope": "window",
"type": "string"
},
Expand All @@ -217,10 +217,29 @@
"items": {
"type": "string"
},
"markdownDescription": "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.",
"markdownDescription": "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.\n\n**This setting is used only by the native server.**",
"scope": "resource",
"type": "array"
},
"ruff.logFile": {
"default": null,
"markdownDescription": "Path to the log file for the language server.\n\n**This setting is used only by the native server.**",
"scope": "window",
"type": "string"
},
"ruff.logLevel": {
"default": null,
"enum": [
"error",
"warning",
"info",
"debug",
"trace"
],
"markdownDescription": "Controls the log level of the language server.\n\n**This setting is used only by the native server.**",
"scope": "window",
"type": "string"
},
"ruff.nativeServer": {
"default": "auto",
"enum": [
Expand Down Expand Up @@ -271,7 +290,7 @@
"Run Ruff on save."
],
"markdownDeprecationMessage": "**Deprecated**: Please use `#ruff.lint.run` instead.",
"markdownDescription": "Run Ruff on every keystroke (`onType`) or on save (`onSave`). This setting is not supported by the native server.",
"markdownDescription": "Run Ruff on every keystroke (`onType`) or on save (`onSave`).\n\n**This setting is not supported by the native server.**",
"scope": "window",
"type": "string"
},
Expand Down
Loading

0 comments on commit c282e6c

Please sign in to comment.