mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-20 16:15:43 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

update-script/rust-analyzer: Filter out headers from option descriptions

Browse source 
Headers are not allowed in nixpkgs option descriptions.
This commit is contained in:
Quentin Boyer 2024-08-10 18:56:59 +02:00
parent ad704ddba7
commit dbf6f7bc99
4 changed files with 44 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

45
generated/rust-analyzer.nix
View file

@ -1987,15 +1987,18 @@
};
"rust-analyzer.workspace.discoverConfig" = {
description = ''
Enables automatic discovery of projects using [`DiscoverWorkspaceConfig::command`].
Enables automatic discovery of projects using
\[`DiscoverWorkspaceConfig::command`\].
[`DiscoverWorkspaceConfig`] also requires setting `progress_label` and `files_to_watch`.
`progress_label` is used for the title in progress indicators, whereas `files_to_watch`
is used to determine which build system-specific files should be watched in order to
reload rust-analyzer.
\[`DiscoverWorkspaceConfig`\] also requires setting `progress_label` and
`files_to_watch`. `progress_label` is used for the title in progress
indicators, whereas `files_to_watch` is used to determine which build
system-specific files should be watched in order to reload
rust-analyzer.
Below is an example of a valid configuration:
```json
``` json
"rust-analyzer.workspace.discoverConfig": {
"command": [
"rust-project",
@ -2009,14 +2012,14 @@
}
```
## On `DiscoverWorkspaceConfig::command`
**On `DiscoverWorkspaceConfig::command`**
**Warning**: This format is provisional and subject to change.
[`DiscoverWorkspaceConfig::command`] *must* return a JSON object
\[`DiscoverWorkspaceConfig::command`\] *must* return a JSON object
corresponding to `DiscoverProjectData::Finished`:
```norun
``` norun
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(tag = "kind")]
#[serde(rename_all = "snake_case")]
@ -2029,7 +2032,7 @@
As JSON, `DiscoverProjectData::Finished` is:
```json
``` json
{
// the internally-tagged representation of the enum.
"kind": "finished",
@ -2051,7 +2054,7 @@
which will be substituted with the JSON-serialized form of the following
enum:
```norun
``` norun
#[derive(PartialEq, Clone, Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum DiscoverArgument {
@ -2062,7 +2065,7 @@
The JSON representation of `DiscoverArgument::Path` is:
```json
``` json
{
"path": "src/main.rs"
}
@ -2070,17 +2073,17 @@
Similarly, the JSON representation of `DiscoverArgument::Buildfile` is:
```
{
"buildfile": "BUILD"
}
```
{
"buildfile": "BUILD"
}
`DiscoverArgument::Path` is used to find and generate a `rust-project.json`,
and therefore, a workspace, whereas `DiscoverArgument::buildfile` is used to
to update an existing workspace. As a reference for implementors,
buck2's `rust-project` will likely be useful:
`DiscoverArgument::Path` is used to find and generate a
`rust-project.json`, and therefore, a workspace, whereas
`DiscoverArgument::buildfile` is used to to update an existing
workspace. As a reference for implementors, buck2's `rust-project` will
likely be useful:
https://github.com/facebook/buck2/tree/main/integrations/rust-project.
'';
pluginDefault = null;
type = {