internal : redesign rust-analyzer::config #16639

alibektas · 2024-02-22T23:29:32Z

This PR aims to cover the infrastructural requirements for the rust-analyzer.toml ( #13529 ) issue. This means, that

We no longer have a single config base. The once single ConfigData has been divided into 4 : A tree of .ratoml files, a set of configs coming from the client ( this is what was called before the CrateData except that now values do not default to anything when they are not defined) , a set of configs that will reflect what the contents of a ratoml file defined in user's config directory ( e.g ~/.config/rust-analyzer/.rust-analyzer.toml and finally a tree root that is populated by default values only.
Configs have also been divided into 3 different blocks : global , local , client. The current status of a config may change until rust-analyzer.toml #13529 got merged.

Once again many thanks to @cormacrelf for doing all the serde work.

alibektas · 2024-02-24T14:31:08Z

I do not think the remaining clippy errors make much sense in this case.

crates/rust-analyzer/src/handlers/request.rs

crates/rust-analyzer/src/config.rs

crates/base-db/Cargo.toml

crates/rust-analyzer/src/config.rs

Veykril · 2024-02-27T10:33:15Z

crates/rust-analyzer/src/config.rs

+/// some rust-analyzer.toml file or JSON blob. An empty rust-analyzer.toml corresponds to
+/// all fields being None.
+#[derive(Debug, Clone, Serialize, Default)]
+struct ConfigInput {


It is a bit unfortunate that we store unrelated configs in certain layers (global layer containing client configs for example). Would be nice to split that out somehow

Two options come to mind:

We can declare non-root nodes as of type LocalConfigInput. The problem with this is that once the root node is deleted, one of these non-roots will become a root-node and needs to be upgraded to a ConfigInput for which the rest of the configs can either be fetched from vfs but this is not sth we'd want to have as this would mean that config::Configneeds to have a reference to vfs. The second option is that I somehow compress rest of the data and take the load off of memory and then load it when needed. But I have no idea how this is done.

Why would the root node be deletable? There is always one root node (if it doesn't exist as a file it should just be set to the default)

crates/rust-analyzer/src/config.rs

Veykril · 2024-02-27T10:50:41Z

Haven't looked at the split between local global and client yet. Will do that later. Additionally, one thing for a follow up we should look at is whether we can discard the json ptr deserialization approach now that the config structure is fully typed.

bors · 2024-03-02T09:52:06Z

☔ The latest upstream changes (presumably #16704) made this pull request unmergeable. Please resolve the merge conflicts.

bors · 2024-03-05T08:57:13Z

☔ The latest upstream changes (presumably #16752) made this pull request unmergeable. Please resolve the merge conflicts.

crates/rust-analyzer/src/config.rs

bors · 2024-03-11T09:57:08Z

☔ The latest upstream changes (presumably #16473) made this pull request unmergeable. Please resolve the merge conflicts.

alibektas · 2024-03-12T02:39:02Z

I am not satisfied with what I have now, but I also need to move forward with actually implementing ratoml tree to see what I need and what I don't.

Veykril · 2024-03-12T15:05:15Z

crates/rust-analyzer/src/config.rs

@@ -6,7 +6,7 @@
 //! Of particular interest is the `feature_flags` hash map: while other fields
 //! configure the server itself, feature flags are passed into analysis, and
 //! tweak things like automatic insertion of `()` in completions.
-
+#![allow(dead_code)]


This should be removed ideally

there are parts that actually belong to what is to be implemented, so I can't remove this just yet.

crates/rust-analyzer/src/config.rs

bors · 2024-03-19T15:12:05Z

☔ The latest upstream changes (presumably #16889) made this pull request unmergeable. Please resolve the merge conflicts.

alibektas · 2024-03-22T00:11:35Z

For integration tests it is necessary to discuss what will belong to global/local/client. After that, this part can be actually be merged.

bors · 2024-03-25T22:27:15Z

☔ The latest upstream changes (presumably #16906) made this pull request unmergeable. Please resolve the merge conflicts.

This commit makes rust-analyzer::config module TOML ser and de. Co-Authored-By: Cormac Relf <web@cormacrelf.net>

Veykril · 2024-04-16T07:50:59Z

@bors r+

bors · 2024-04-16T07:51:02Z

📌 Commit 60d3a73 has been approved by Veykril

It is now in the queue for this repository.

bors · 2024-04-16T07:52:10Z

⌛ Testing commit 60d3a73 with merge 1179c3e...

bors · 2024-04-16T08:04:40Z

☀️ Test successful - checks-actions
Approved by: Veykril
Pushing 1179c3e to master...

feat: TOML based config for rust-analyzer # TOML Based Config for RA This PR ( fixes #13529 and this is a follow-up PR on #16639 ) makes rust-analyzer configurable by configuration files called `rust-analyzer.toml`. Files **must** be named `rust-analyzer.toml`. There is not a strict rule regarding where the files should be placed, but it is recommended to put them near a file that triggers server to start (i.e., `Cargo.{toml,lock}`, `rust-project.json`). ## Configuration Types Previous configuration keys are now split into three different classes. 1. Client keys: These keys only make sense when set by the client (e.g., by setting them in `settings.json` in VSCode). They are but a small portion of this list. One such example is `rust_analyzer.files_watcher`, based on which either the client or the server will be responsible for watching for changes made to project files. 2. Global keys: These keys apply to the entire workspace and can only be set on the very top layers of the hierarchy. The next section gives instructions on which layers these are. 3. Local keys: Keys that can be changed for each crate if desired. ### How Am I Supposed To Know If A Config Is Gl/Loc/Cl ? #17101 ## Configuration Hierarchy There are 5 levels in the configuration hierarchy. When a key is searched for, it is searched in a bottom-up depth-first fashion. ### Default Configuration **Scope**: Global, Local, and Client This is a hard-coded set of configurations. When a configuration key could not be found, then its default value applies. ### User configuration **Scope**: Global, Local If you want your configurations to apply to **every** project you have, you can do so by setting them in your `$CONFIG_DIR/rust-analyzer/rust-analyzer.toml` file, where `$CONFIG_DIR` is : | Platform | Value | Example | | ------- | ------------------------------------- | ---------------------------------------- | | Linux | `$XDG_CONFIG_HOME` or `$HOME`/.config | /home/alice/.config | | macOS | `$HOME`/Library/Application Support | /Users/Alice/Library/Application Support | | Windows | `{FOLDERID_RoamingAppData}` | C:\Users\Alice\AppData\Roaming | ### Client configuration **Scope**: Global, Local, and Client Previously, the only way to configure rust-analyzer was to configure it from the settings of the Client you are using. This level corresponds to that. > With this PR, you don't need to port anything to benefit from new features. You can continue to use your old settings as they are. ### Workspace Root Configuration **Scope**: Global, Local Rust-analyzer already used the path of the workspace you opened in your Client. We used this information to create a configuration file that won't affect your other projects and define global level configurations at the same time. ### Local Configuration **Scope**: Local You can also configure rust-analyzer on a crate level. Although it is not an error to define global ( or client ) level keys in such files, they won't be taken into consideration by the server. Defined local keys will affect the crate in which they are defined and crate's descendants. Internally, a Rust project is split into what we call `SourceRoot`s. This, although with exceptions, is equal to splitting a project into crates. > You may choose to have more than one `rust-analyzer.toml` files within a `SourceRoot`, but among them, the one closer to the project root will be

feat: TOML based config for rust-analyzer > Important > > We don't promise _**any**_ stability with this feature yet, any configs exposed may be removed again, the grouping may change etc. # TOML Based Config for RA This PR ( addresses #13529 and this is a follow-up PR on #16639 ) makes rust-analyzer configurable by configuration files called `rust-analyzer.toml`. Files **must** be named `rust-analyzer.toml`. There is not a strict rule regarding where the files should be placed, but it is recommended to put them near a file that triggers server to start (i.e., `Cargo.{toml,lock}`, `rust-project.json`). ## Configuration Types Previous configuration keys are now split into three different classes. 1. Client keys: These keys only make sense when set by the client (e.g., by setting them in `settings.json` in VSCode). They are but a small portion of this list. One such example is `rust_analyzer.files_watcher`, based on which either the client or the server will be responsible for watching for changes made to project files. 2. Global keys: These keys apply to the entire workspace and can only be set on the very top layers of the hierarchy. The next section gives instructions on which layers these are. 3. Local keys: Keys that can be changed for each crate if desired. ### How Am I Supposed To Know If A Config Is Gl/Loc/Cl ? #17101 ## Configuration Hierarchy There are 5 levels in the configuration hierarchy. When a key is searched for, it is searched in a bottom-up depth-first fashion. ### Default Configuration **Scope**: Global, Local, and Client This is a hard-coded set of configurations. When a configuration key could not be found, then its default value applies. ### User configuration **Scope**: Global, Local If you want your configurations to apply to **every** project you have, you can do so by setting them in your `$CONFIG_DIR/rust-analyzer/rust-analyzer.toml` file, where `$CONFIG_DIR` is : | Platform | Value | Example | | ------- | ------------------------------------- | ---------------------------------------- | | Linux | `$XDG_CONFIG_HOME` or `$HOME`/.config | /home/alice/.config | | macOS | `$HOME`/Library/Application Support | /Users/Alice/Library/Application Support | | Windows | `{FOLDERID_RoamingAppData}` | C:\Users\Alice\AppData\Roaming | ### Client configuration **Scope**: Global, Local, and Client Previously, the only way to configure rust-analyzer was to configure it from the settings of the Client you are using. This level corresponds to that. > With this PR, you don't need to port anything to benefit from new features. You can continue to use your old settings as they are. ### Workspace Root Configuration **Scope**: Global, Local Rust-analyzer already used the path of the workspace you opened in your Client. We used this information to create a configuration file that won't affect your other projects and define global level configurations at the same time. ### Local Configuration **Scope**: Local You can also configure rust-analyzer on a crate level. Although it is not an error to define global ( or client ) level keys in such files, they won't be taken into consideration by the server. Defined local keys will affect the crate in which they are defined and crate's descendants. Internally, a Rust project is split into what we call `SourceRoot`s. This, although with exceptions, is equal to splitting a project into crates. > You may choose to have more than one `rust-analyzer.toml` files within a `SourceRoot`, but among them, the one closer to the project root will be

rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Feb 22, 2024

alibektas force-pushed the 13529/config_restruct branch from 6db7040 to 9208256 Compare February 22, 2024 23:47

Veykril reviewed Feb 27, 2024

View reviewed changes

crates/rust-analyzer/src/config.rs Outdated Show resolved Hide resolved

Veykril added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 27, 2024

alibektas force-pushed the 13529/config_restruct branch from f94ef73 to fa7f873 Compare March 5, 2024 00:24

davidbarsky reviewed Mar 5, 2024

View reviewed changes

crates/rust-analyzer/src/config.rs Outdated Show resolved Hide resolved

crates/rust-analyzer/src/config.rs Show resolved Hide resolved

alibektas force-pushed the 13529/config_restruct branch from fa7f873 to f582c5b Compare March 5, 2024 17:24

alibektas mentioned this pull request Mar 5, 2024

Discarding json ptr deserialization for config::Config #16764

Open

alibektas force-pushed the 13529/config_restruct branch from f582c5b to df101f4 Compare March 5, 2024 20:13

alibektas force-pushed the 13529/config_restruct branch from df101f4 to b313968 Compare March 12, 2024 02:36

alibektas added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Mar 12, 2024

Veykril reviewed Mar 12, 2024

View reviewed changes

alibektas force-pushed the 13529/config_restruct branch 2 times, most recently from 8a4a7b2 to 2059584 Compare March 22, 2024 00:37

alibektas force-pushed the 13529/config_restruct branch 2 times, most recently from faa79ba to 747addb Compare April 12, 2024 19:26

alibektas mentioned this pull request Apr 13, 2024

feat: TOML based config for rust-analyzer #17058

Merged

alibektas and others added 2 commits April 15, 2024 14:14

Make ConfigData Ser and TOML De

67d8d2d

This commit makes rust-analyzer::config module TOML ser and de. Co-Authored-By: Cormac Relf <web@cormacrelf.net>

Differentiate between full configs and toml only config groupings

60d3a73

Veykril force-pushed the 13529/config_restruct branch from 747addb to 60d3a73 Compare April 15, 2024 12:16

bors merged commit 1179c3e into rust-lang:master Apr 16, 2024
11 checks passed

This was referenced Apr 16, 2024

Add possible values in the doc #16315

Closed

RFC: Hide size/layout information by default #16825

Closed

Support hovering limits for adts #17021

Merged

philips-software-forest-releaser bot mentioned this pull request Jun 4, 2024

chore(deps,rust): update rust-lang.rust-analyzer philips-software/amp-devcontainer#436

Merged

This was referenced Jun 11, 2024

chore(deps,rust): update rust-lang.rust-analyzer philips-software/amp-devcontainer#445

Merged

chore(deps,rust): update rust-lang.rust-analyzer philips-software/amp-devcontainer#447

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

internal : redesign rust-analyzer::config #16639

internal : redesign rust-analyzer::config #16639

alibektas commented Feb 22, 2024 •

edited

alibektas commented Feb 24, 2024

Veykril Feb 27, 2024

alibektas Mar 4, 2024

Veykril Mar 12, 2024

Veykril commented Feb 27, 2024

bors commented Mar 2, 2024

bors commented Mar 5, 2024

bors commented Mar 11, 2024

alibektas commented Mar 12, 2024

Veykril Mar 12, 2024

alibektas Mar 22, 2024

bors commented Mar 19, 2024

alibektas commented Mar 22, 2024

bors commented Mar 25, 2024

Veykril commented Apr 16, 2024

bors commented Apr 16, 2024

bors commented Apr 16, 2024

bors commented Apr 16, 2024

internal : redesign rust-analyzer::config #16639

internal : redesign rust-analyzer::config #16639

Conversation

alibektas commented Feb 22, 2024 • edited

alibektas commented Feb 24, 2024

Veykril Feb 27, 2024

Choose a reason for hiding this comment

alibektas Mar 4, 2024

Choose a reason for hiding this comment

Veykril Mar 12, 2024

Choose a reason for hiding this comment

Veykril commented Feb 27, 2024

bors commented Mar 2, 2024

bors commented Mar 5, 2024

bors commented Mar 11, 2024

alibektas commented Mar 12, 2024

Veykril Mar 12, 2024

Choose a reason for hiding this comment

alibektas Mar 22, 2024

Choose a reason for hiding this comment

bors commented Mar 19, 2024

alibektas commented Mar 22, 2024

bors commented Mar 25, 2024

Veykril commented Apr 16, 2024

bors commented Apr 16, 2024

bors commented Apr 16, 2024

bors commented Apr 16, 2024

alibektas commented Feb 22, 2024 •

edited