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 Dec 6, 2024
1 parent d5ca361 commit 27ffa3a
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 79 deletions.
42 changes: 24 additions & 18 deletions schemas/als.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
"description": "Ada & SPARK IntelliSense, code browsing, debugging and more.",
"properties": {
"ada.defaultCharset": {
"default": "iso-8859-1",
"default": null,
"description": "The character set that the Ada Language Server should use when reading files from disk.",
"scope": "window",
"type": "string"
},
"ada.displayMethodAncestryOnNavigation": {
"default": "usage_and_abstract_only",
"default": null,
"description": "Controls the policy for displaying overriding and overridden subprograms on navigation requests such as 'Go To Definition' or 'Go To Implementations'.",
"enum": [
"never",
Expand All @@ -27,7 +27,7 @@
"type": "string"
},
"ada.documentationStyle": {
"default": "gnat",
"default": null,
"description": "Controls the primary documentation style of entities.",
"enum": [
"gnat",
Expand All @@ -41,81 +41,87 @@
"type": "string"
},
"ada.enableDiagnostics": {
"default": true,
"default": null,
"description": "Controls whether or not the Ada Language Server should emit diagnostics into the VS Code Problems view.",
"scope": "window",
"type": "boolean"
},
"ada.enableIndexing": {
"default": true,
"default": null,
"description": "Controls whether the Ada Language Server should index the source files immediately after loading a project.\n\nIf set to false, indexing will be deferred to the time when an action requiring the index is first performed, e.g. hovering over a referenced entity to get its documentation.",
"scope": "window",
"type": "boolean"
},
"ada.foldComments": {
"default": true,
"default": null,
"description": "Controls whether comments should be folded like code blocks.",
"scope": "window",
"type": "boolean"
},
"ada.followSymlinks": {
"default": true,
"default": null,
"description": "Controls the Ada Language Server normalizes the file paths received from the client.",
"scope": "window",
"type": "boolean"
},
"ada.insertWithClauses": {
"default": false,
"default": null,
"description": "Enable insertion of missing with-clauses when accepting completion for invisible symbols.",
"scope": "window",
"type": "boolean"
},
"ada.logThreshold": {
"default": null,
"description": "Controls the maximum number of trace files preserved in the ALS log directory (which defaults to `~/.als`). When this threshold is reached, old trace files get deleted automatically. The default number of preserved trace files is `10`.",
"scope": "window",
"type": "integer"
},
"ada.namedNotationThreshold": {
"default": 3,
"default": null,
"description": "Defines the number of parameters/components beyond which named notation is used for completion snippets.",
"scope": "window",
"type": "integer"
},
"ada.onTypeFormatting.indentOnly": {
"default": true,
"default": null,
"markdownDescription": "If the VS Code `editor.formatOnType` setting is enabled, the Ada Language Server will format Ada code while it is being typed in the editor, in particular when a new line is typed.\n\nThis setting controls whether formatting should only perform the indentation of the new line (true) or also format the previous line (false).",
"scope": "window",
"type": "boolean"
},
"ada.projectDiagnostics": {
"default": true,
"default": null,
"description": "Controls whether or not the Ada Language Server should emit project diagnostics into the VS Code Problems view.\n\nNote: this setting is ignored if `ada.enableDiagnostics` is disabled and a workspace reload is necessary to refresh the diagnostics after modifying this setting.",
"scope": "window",
"type": "boolean"
},
"ada.projectFile": {
"default": "",
"default": null,
"description": "GPR project file (*.gpr) for this workspace.\n\nIt is recommended to set this to a relative path starting at the root of the workspace.",
"order": 0,
"scope": "window",
"type": "string"
},
"ada.relocateBuildTree": {
"default": "",
"default": null,
"description": "The folder for out-of-tree build.",
"markdownDescription": "The path to a directory used for out-of-tree builds. This feature is related to the [--relocate-build-tree GPRbuild command line switch](https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug/building_with_gprbuild.html#switches).",
"scope": "window",
"type": "string"
},
"ada.renameInComments": {
"default": false,
"default": null,
"description": "Enable editing Ada comments to update references to an entity when it is being renamed.",
"scope": "window",
"type": "boolean"
},
"ada.rootDir": {
"default": "",
"default": null,
"markdownDescription": "This setting must be used in conjunction with the `relocateBuildTree` setting.\n\nIt specifies the root directory for artifact relocation. It corresponds to the [--root-dir GPRbuild command line switch](https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug/building_with_gprbuild.html#switches).",
"scope": "window",
"type": "string"
},
"ada.scenarioVariables": {
"default": {},
"default": null,
"description": "Scenario variables to apply to the GPR project file.\n\nThis value should be provided as an object where the property names are GPR scenario variables and the values are strings.",
"order": 1,
"patternProperties": {
Expand Down Expand Up @@ -148,13 +154,13 @@
"type": "string"
},
"ada.useCompletionSnippets": {
"default": false,
"default": null,
"description": "Enable snippets in completion results (e.g. subprogram calls).",
"scope": "window",
"type": "boolean"
},
"ada.useGnatformat": {
"default": true,
"default": null,
"markdownDescription": "Enable GNATformat as the formatting provider for Ada source files.",
"scope": "window",
"type": "boolean"
Expand Down
2 changes: 1 addition & 1 deletion schemas/rust_analyzer.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1470,7 +1470,7 @@
"type": "boolean"
},
"rust-analyzer.typing.excludeChars": {
"default": null,
"default": "<",
"markdownDescription": "Specify the characters to exclude from triggering typing assists. The default trigger characters are `.`, `=`, `<`, `>`, `{`, and `(`. Setting this to a string will disable typing assists for the specified characters.",
"type": [
"null",
Expand Down
66 changes: 6 additions & 60 deletions types/lsp.lua
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@
-- If the VS Code `editor.formatOnType` setting is enabled, the Ada Language Server will format Ada code while it is being typed in the editor, in particular when a new line is typed.
--
-- This setting controls whether formatting should only perform the indentation of the new line (true) or also format the previous line (false).
--
-- ```lua
-- default = true
-- ```
---@field indentOnly boolean

---@class _.lspconfig.settings.als.Trace
Expand All @@ -21,108 +17,54 @@

---@class _.lspconfig.settings.als.Ada
-- The character set that the Ada Language Server should use when reading files from disk.
--
-- ```lua
-- default = "iso-8859-1"
-- ```
---@field defaultCharset string
-- Controls the policy for displaying overriding and overridden subprograms on navigation requests such as 'Go To Definition' or 'Go To Implementations'.
--
-- ```lua
-- default = "usage_and_abstract_only"
-- ```
---@field displayMethodAncestryOnNavigation "never" | "usage_and_abstract_only" | "definition_only" | "always"
-- Controls the primary documentation style of entities.
--
-- ```lua
-- default = "gnat"
-- ```
---@field documentationStyle "gnat" | "leading"
-- Controls whether or not the Ada Language Server should emit diagnostics into the VS Code Problems view.
--
-- ```lua
-- default = true
-- ```
---@field enableDiagnostics boolean
-- Controls whether the Ada Language Server should index the source files immediately after loading a project.
--
-- If set to false, indexing will be deferred to the time when an action requiring the index is first performed, e.g. hovering over a referenced entity to get its documentation.
--
-- ```lua
-- default = true
-- ```
---@field enableIndexing boolean
-- Controls whether comments should be folded like code blocks.
--
-- ```lua
-- default = true
-- ```
---@field foldComments boolean
-- Controls the Ada Language Server normalizes the file paths received from the client.
--
-- ```lua
-- default = true
-- ```
---@field followSymlinks boolean
-- Enable insertion of missing with-clauses when accepting completion for invisible symbols.
---@field insertWithClauses boolean
-- Controls the maximum number of trace files preserved in the ALS log directory (which defaults to `~/.als`). When this threshold is reached, old trace files get deleted automatically. The default number of preserved trace files is `10`.
---@field logThreshold integer
-- Defines the number of parameters/components beyond which named notation is used for completion snippets.
--
-- ```lua
-- default = 3
-- ```
---@field namedNotationThreshold integer
---@field onTypeFormatting _.lspconfig.settings.als.OnTypeFormatting
-- Controls whether or not the Ada Language Server should emit project diagnostics into the VS Code Problems view.
--
-- Note: this setting is ignored if `ada.enableDiagnostics` is disabled and a workspace reload is necessary to refresh the diagnostics after modifying this setting.
--
-- ```lua
-- default = true
-- ```
---@field projectDiagnostics boolean
-- GPR project file (*.gpr) for this workspace.
--
-- It is recommended to set this to a relative path starting at the root of the workspace.
--
-- ```lua
-- default = ""
-- ```
---@field projectFile string
-- The path to a directory used for out-of-tree builds. This feature is related to the [--relocate-build-tree GPRbuild command line switch](https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug/building_with_gprbuild.html#switches).
--
-- ```lua
-- default = ""
-- ```
---@field relocateBuildTree string
-- Enable editing Ada comments to update references to an entity when it is being renamed.
---@field renameInComments boolean
-- This setting must be used in conjunction with the `relocateBuildTree` setting.
--
-- It specifies the root directory for artifact relocation. It corresponds to the [--root-dir GPRbuild command line switch](https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug/building_with_gprbuild.html#switches).
--
-- ```lua
-- default = ""
-- ```
---@field rootDir string
-- Scenario variables to apply to the GPR project file.
--
-- This value should be provided as an object where the property names are GPR scenario variables and the values are strings.
--
-- ```lua
-- default = {}
-- ```
---@field scenarioVariables table
-- Whether to show error notifications for failing LSP requests.
---@field showNotificationsOnErrors boolean
---@field trace _.lspconfig.settings.als.Trace
-- Enable snippets in completion results (e.g. subprogram calls).
---@field useCompletionSnippets boolean
-- Enable GNATformat as the formatting provider for Ada source files.
--
-- ```lua
-- default = true
-- ```
---@field useGnatformat boolean

---@class _.lspconfig.settings.als.Trace
Expand Down Expand Up @@ -14297,6 +14239,10 @@
-- ```
---@field continueCommentsOnNewline boolean
-- Specify the characters to exclude from triggering typing assists. The default trigger characters are `.`, `=`, `<`, `>`, `{`, and `(`. Setting this to a string will disable typing assists for the specified characters.
--
-- ```lua
-- default = "<"
-- ```
---@field excludeChars string

---@class _.lspconfig.settings.rust_analyzer.Search
Expand Down

0 comments on commit 27ffa3a

Please sign in to comment.