feat: TOML based config for rust-analyzer #17058

alibektas · 2024-04-13T11:05:44Z

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.

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.
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.
Workspace keys: These keys apply to a single workspace (TBD).
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 Configuration

Scope: Global, Workspace, Local

A rust-analyzer.toml file that is located at the root of your workspace can be used to configure all of the mentioned scopes. A workspace scope does in practice not exist but will soon be implemented and these files will soon not have a global scope but rather only workspace and local.

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 SourceRoots. 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

davidbarsky

some nits; i'll try to review more later.

crates/rust-analyzer/tests/slow-tests/main.rs

crates/rust-analyzer/src/reload.rs

crates/rust-analyzer/src/mem_docs.rs

crates/rust-analyzer/src/main_loop.rs

crates/rust-analyzer/src/config.rs

davidbarsky · 2024-04-14T21:08:33Z

crates/rust-analyzer/src/config.rs

@@ -827,16 +1177,45 @@ impl Config {
        caps: ClientCapabilities,
        workspace_roots: Vec<AbsPathBuf>,
        visual_studio_code_version: Option<Version>,
+        user_config_path: Option<Utf8PathBuf>,


question: are there non-user config paths? i would just rename all usage here to config_path, IMO.

(i see a "root config path", but I'd remove the user qualifier entirely.)

the user here refers to the user's home dir I think

Yeah naming things is not my strength. I though of XDG_CONFIG_.. but that is also not very accurate either. As a matter of fact it was Veykril's suggestion to change it to user_config. In any case the name is still the same but I added comment.

davidbarsky · 2024-04-14T21:11:55Z

crates/rust-analyzer/src/config.rs

+            client_config: ClientConfig::default(),
+            user_config: None,
+            ratoml_files: FxHashMap::default(),
+            default_config: ConfigData::default(),
+            source_root_parent_map: Arc::new(FxHashMap::default()),
+            user_config_path,
+            root_ratoml: None,
+            root_ratoml_path,
+            should_update: false,


I'd do two things:

keep ConfigData named data instead of default_config.

I'd group all the configuration file-related values into their own wrapper struct.

davidbarsky · 2024-04-14T21:13:36Z

crates/rust-analyzer/src/config.rs

+        // FIXME @alibektas : This is the only config that is confusing. If it's a proper configuration
+        // why is it not among the others? If it's client only which I doubt it is current state should be alright


it's weird because the VS Code extension, by default, cares about what folder rust-analyzer is running in. it's debatable whether it makes sense in this context, but I'm inclined to think it does.

This is indeed a very odd config and only necessary (I hope) because we are lacking proper support for handling detached files currently.

Veykril

Also not a complete review yet, will give the previous PR another pass and merge that first (then adjust things as I see to speed up things, instead of doing more review rounds on that)

crates/rust-analyzer/src/cli/scip.rs

crates/rust-analyzer/src/global_state.rs

crates/rust-analyzer/src/mem_docs.rs

crates/rust-analyzer/src/global_state.rs

crates/rust-analyzer/src/config.rs

bors · 2024-04-16T08:07:24Z

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

bors · 2024-04-19T21:04:22Z

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

crates/paths/src/lib.rs

crates/rust-analyzer/src/cli/scip.rs

crates/rust-analyzer/tests/slow-tests/support.rs

crates/rust-analyzer/src/lib.rs

crates/rust-analyzer/src/main_loop.rs

crates/rust-analyzer/src/config.rs

crates/rust-analyzer/src/global_state.rs

bors · 2024-04-21T15:07:03Z

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

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

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

Veykril

2 more things otherwise I think this is good to go

crates/rust-analyzer/tests/slow-tests/support.rs

crates/rust-analyzer/src/config.rs

Veykril · 2024-04-29T08:21:14Z

@bors delegate+

bors · 2024-04-29T08:21:17Z

✌️ @alibektas, you can now approve this pull request!

If @Veykril told you to "r=me" after making some further change, please make that change, then do @bors r=@Veykril

alibektas · 2024-04-29T20:34:09Z

My splitting the config keys into global/local/client wasn't really meticulous, because I was thinking that you would intervene at some point 😄. Are we planning to this in the near future or do you want to take a look before I actually merge this PR @Veykril ?

Veykril · 2024-04-29T20:51:38Z

I haven't given the split a look yet tbf, I can do that afterwards / once you've fixed up the rest here

Veykril · 2024-06-05T12:57:13Z

Okay diagnostics work now, though the UX is horrible for now and this generally needs some cleanup that I'll task @alibektas with as a follow up. It also seems like the server hangs up when you create a fresh toml file so I'll investigate that later

Veykril · 2024-06-06T08:46:30Z

@bors r+

bors · 2024-06-06T08:46:33Z

📌 Commit 3178e5f has been approved by Veykril

It is now in the queue for this repository.

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

bors · 2024-06-06T08:47:41Z

⌛ Testing commit 3178e5f with merge 6e427d8...

bors · 2024-06-06T08:54:13Z

💔 Test failed - checks-actions

Veykril · 2024-06-07T10:41:10Z

@bors r+

bors · 2024-06-07T10:41:13Z

📌 Commit 5a7bf1d has been approved by Veykril

It is now in the queue for this repository.

Veykril · 2024-06-07T10:41:41Z

Quoting my comment on #13529 for visibility:

#17058 will implement the core features here, there are still some issues with it (the user config is not working correctly yet), as well some restrictions with crate specific configs due to architecture reasons (they shouldn't really be noticeably in most cases). A lot of configs are also still missing from it and the diagnostics UX (when an invalid config is supplied) is really bad. All of that will be resolved in the near or far future (time will tell).

Important

We don't promise any stability with this feature yet, any configs exposed may be removed again, the ordering may change etc.

Once the PR lands (should today), this issue will be used to track any updates on the feature.

bors · 2024-06-07T10:49:05Z

⌛ Testing commit 5a7bf1d with merge 7c5d496...

bors · 2024-06-07T11:01:32Z

☀️ Test successful - checks-actions
Approved by: Veykril
Pushing 7c5d496 to master...

minor : fixes for ratoml module This is a follow-up PR to #17058. - Parse errors are reflected as such by defining a new variant called `ConfigError::ParseError` - New error collection has been added to store config level agnostic errors. EDIT : Some things that this PR promised to solve are removed and will be addressed by other PRs

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

alibektas force-pushed the 13529/ratoml branch from e4b15eb to 12e154f Compare April 13, 2024 11:09

alibektas requested review from davidbarsky and Veykril April 13, 2024 11:42

alibektas changed the title ~~feature: TOML based config for rust-analyzer~~ feat: TOML based config for rust-analyzer Apr 13, 2024

davidbarsky reviewed Apr 14, 2024

View reviewed changes

Veykril reviewed Apr 15, 2024

View reviewed changes

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 Apr 18, 2024

alibektas force-pushed the 13529/ratoml branch from 12e154f to 9cce938 Compare April 18, 2024 16:21

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 Apr 18, 2024

alibektas mentioned this pull request Apr 18, 2024

Add tags local/global/client to config docs #17101

Open

alibektas force-pushed the 13529/ratoml branch from 9cce938 to b03ce39 Compare April 20, 2024 13:54

Veykril reviewed Apr 21, 2024

View reviewed changes

alibektas mentioned this pull request Apr 27, 2024

Unify DocumentFilters in rust-analyzer module #17154

Open

alibektas force-pushed the 13529/ratoml branch 2 times, most recently from 74e7863 to 2199f2d Compare April 28, 2024 11:27

Veykril reviewed Apr 29, 2024

View reviewed changes

crates/rust-analyzer/tests/slow-tests/support.rs Show resolved Hide resolved

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 Apr 29, 2024

alibektas force-pushed the 13529/ratoml branch from 2199f2d to 861713e Compare April 29, 2024 20:57

Fix file loading of r-a toml files

3178e5f

Veykril force-pushed the 13529/ratoml branch from 1316ba4 to 3178e5f Compare June 6, 2024 08:40

Veykril force-pushed the 13529/ratoml branch 2 times, most recently from 4c2b832 to 3178e5f Compare June 7, 2024 10:23

Veykril mentioned this pull request Jun 7, 2024

rust-analyzer.toml #13529

Open

5 tasks

Fix processing of ratoml files

5a7bf1d

Veykril force-pushed the 13529/ratoml branch from e37c1be to 5a7bf1d Compare June 7, 2024 10:31

bors merged commit 7c5d496 into rust-lang:master Jun 7, 2024
11 checks passed

bors mentioned this pull request Jun 7, 2024

Allow rust-project.json to include arbitrary shell commands for runnables #16840

Merged

hw0lff mentioned this pull request Jun 7, 2024

Missing reference documentation for configuration parameters #13178

Open

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

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

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

Merged

alibektas mentioned this pull request Jun 23, 2024

minor : fixes for ratoml module #17483

Merged

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

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

Merged

lukashermansson mentioned this pull request Jul 2, 2024

Document unstable project based rust analyzer config to override rustfmt bram209/leptosfmt#126

Closed

alibektas mentioned this pull request Aug 2, 2024

Detect if code is running via rust-analyzer #17766

Open

lnicola mentioned this pull request Aug 6, 2024

RA ignores vscode settings in multiroot workspace #17810

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: TOML based config for rust-analyzer #17058

feat: TOML based config for rust-analyzer #17058

alibektas commented Apr 13, 2024 •

edited

Loading

davidbarsky left a comment

davidbarsky Apr 14, 2024

Veykril Apr 15, 2024

alibektas Apr 18, 2024 •

edited

Loading

davidbarsky Apr 14, 2024

davidbarsky Apr 14, 2024

Veykril Apr 15, 2024

Veykril left a comment

bors commented Apr 16, 2024

bors commented Apr 19, 2024

bors commented Apr 21, 2024

bors commented Apr 29, 2024

Veykril left a comment

Veykril commented Apr 29, 2024

bors commented Apr 29, 2024

alibektas commented Apr 29, 2024 •

edited

Loading

Veykril commented Apr 29, 2024

Veykril commented Jun 5, 2024

Veykril commented Jun 6, 2024

bors commented Jun 6, 2024

bors commented Jun 6, 2024

bors commented Jun 6, 2024

Veykril commented Jun 7, 2024

bors commented Jun 7, 2024

Veykril commented Jun 7, 2024

bors commented Jun 7, 2024

bors commented Jun 7, 2024

		// FIXME @alibektas : This is the only config that is confusing. If it's a proper configuration
		// why is it not among the others? If it's client only which I doubt it is current state should be alright

feat: TOML based config for rust-analyzer #17058

feat: TOML based config for rust-analyzer #17058

Conversation

alibektas commented Apr 13, 2024 • edited Loading

TOML Based Config for RA

Configuration Types

How Am I Supposed To Know If A Config Is Gl/Loc/Cl ?

Configuration Hierarchy

Default Configuration

User configuration

Client configuration

Workspace Configuration

Local Configuration

davidbarsky left a comment

Choose a reason for hiding this comment

davidbarsky Apr 14, 2024

Choose a reason for hiding this comment

Veykril Apr 15, 2024

Choose a reason for hiding this comment

alibektas Apr 18, 2024 • edited Loading

Choose a reason for hiding this comment

davidbarsky Apr 14, 2024

Choose a reason for hiding this comment

davidbarsky Apr 14, 2024

Choose a reason for hiding this comment

Veykril Apr 15, 2024

Choose a reason for hiding this comment

Veykril left a comment

Choose a reason for hiding this comment

bors commented Apr 16, 2024

bors commented Apr 19, 2024

bors commented Apr 21, 2024

bors commented Apr 29, 2024

Veykril left a comment

Choose a reason for hiding this comment

Veykril commented Apr 29, 2024

bors commented Apr 29, 2024

alibektas commented Apr 29, 2024 • edited Loading

Veykril commented Apr 29, 2024

Veykril commented Jun 5, 2024

Veykril commented Jun 6, 2024

bors commented Jun 6, 2024

bors commented Jun 6, 2024

bors commented Jun 6, 2024

Veykril commented Jun 7, 2024

bors commented Jun 7, 2024

Veykril commented Jun 7, 2024

bors commented Jun 7, 2024

bors commented Jun 7, 2024

alibektas commented Apr 13, 2024 •

edited

Loading

alibektas Apr 18, 2024 •

edited

Loading

alibektas commented Apr 29, 2024 •

edited

Loading