Skip to content

Commit a9f0e20

Browse files
borsbors
committed
Auto merge of #17058 - alibektas:13529/ratoml, r=Veykril
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
2 parents 1eda1ae + 59002b3 commit a9f0e20

File tree

23 files changed

+2143
-585
lines changed

23 files changed

+2143
-585
lines changed

‎src/tools/rust-analyzer/Cargo.lock

+10
Original file line numberDiff line numberDiff line change
@@ -328,6 +328,15 @@ dependencies = [
328328
"dirs-sys",
329329
]
330330

331+
[[package]]
332+
name = "dirs"
333+
version = "5.0.1"
334+
source = "registry+https://github.com/rust-lang/crates.io-index"
335+
checksum = "44c45a9d03d6676652bcb5e724c7e988de1acad23a711b5217ab9cbecbec2225"
336+
dependencies = [
337+
"dirs-sys",
338+
]
339+
331340
[[package]]
332341
name = "dirs-sys"
333342
version = "0.4.1"
@@ -1665,6 +1674,7 @@ dependencies = [
16651674
"anyhow",
16661675
"cfg",
16671676
"crossbeam-channel",
1677+
"dirs",
16681678
"dissimilar",
16691679
"expect-test",
16701680
"flycheck",

‎src/tools/rust-analyzer/crates/ide/src/lib.rs

+8-1
Original file line numberDiff line numberDiff line change
@@ -273,10 +273,17 @@ impl Analysis {
273273
self.with_db(|db| status::status(db, file_id))
274274
}
275275

276-
pub fn source_root(&self, file_id: FileId) -> Cancellable<SourceRootId> {
276+
pub fn source_root_id(&self, file_id: FileId) -> Cancellable<SourceRootId> {
277277
self.with_db(|db| db.file_source_root(file_id))
278278
}
279279

280+
pub fn is_local_source_root(&self, source_root_id: SourceRootId) -> Cancellable<bool> {
281+
self.with_db(|db| {
282+
let sr = db.source_root(source_root_id);
283+
!sr.is_library
284+
})
285+
}
286+
280287
pub fn parallel_prime_caches<F>(&self, num_worker_threads: u8, cb: F) -> Cancellable<()>
281288
where
282289
F: Fn(ParallelPrimeCachesProgress) + Sync + std::panic::UnwindSafe,

‎src/tools/rust-analyzer/crates/load-cargo/src/lib.rs

+5-6
Original file line numberDiff line numberDiff line change
@@ -272,25 +272,24 @@ impl SourceRootConfig {
272272
/// If a `SourceRoot` doesn't have a parent and is local then it is not contained in this mapping but it can be asserted that it is a root `SourceRoot`.
273273
pub fn source_root_parent_map(&self) -> FxHashMap<SourceRootId, SourceRootId> {
274274
let roots = self.fsc.roots();
275-
let mut map = FxHashMap::<SourceRootId, SourceRootId>::default();
275+
let mut i = 0;
276276
roots
277277
.iter()
278278
.enumerate()
279279
.filter(|(_, (_, id))| self.local_filesets.contains(id))
280280
.filter_map(|(idx, (root, root_id))| {
281281
// We are interested in parents if they are also local source roots.
282282
// So instead of a non-local parent we may take a local ancestor as a parent to a node.
283-
roots.iter().take(idx).find_map(|(root2, root2_id)| {
283+
roots[..idx].iter().find_map(|(root2, root2_id)| {
284+
i += 1;
284285
if self.local_filesets.contains(root2_id) && root.starts_with(root2) {
285286
return Some((root_id, root2_id));
286287
}
287288
None
288289
})
289290
})
290-
.for_each(|(child, parent)| {
291-
map.insert(SourceRootId(*child as u32), SourceRootId(*parent as u32));
292-
});
293-
map
291+
.map(|(&child, &parent)| (SourceRootId(child as u32), SourceRootId(parent as u32)))
292+
.collect()
294293
}
295294
}
296295

‎src/tools/rust-analyzer/crates/paths/src/lib.rs

+18
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,24 @@ impl AbsPathBuf {
135135
pub fn pop(&mut self) -> bool {
136136
self.0.pop()
137137
}
138+
139+
/// Equivalent of [`PathBuf::push`] for `AbsPathBuf`.
140+
///
141+
/// Extends `self` with `path`.
142+
///
143+
/// If `path` is absolute, it replaces the current path.
144+
///
145+
/// On Windows:
146+
///
147+
/// * if `path` has a root but no prefix (e.g., `\windows`), it
148+
/// replaces everything except for the prefix (if any) of `self`.
149+
/// * if `path` has a prefix but no root, it replaces `self`.
150+
/// * if `self` has a verbatim prefix (e.g. `\\?\C:\windows`)
151+
/// and `path` is not empty, the new path is normalized: all references
152+
/// to `.` and `..` are removed.
153+
pub fn push<P: AsRef<Utf8Path>>(&mut self, suffix: P) {
154+
self.0.push(suffix)
155+
}
138156
}
139157

140158
impl fmt::Display for AbsPathBuf {

‎src/tools/rust-analyzer/crates/rust-analyzer/Cargo.toml

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ path = "src/bin/main.rs"
2222
[dependencies]
2323
anyhow.workspace = true
2424
crossbeam-channel = "0.5.5"
25+
dirs = "5.0.1"
2526
dissimilar.workspace = true
2627
itertools.workspace = true
2728
scip = "0.3.3"

‎src/tools/rust-analyzer/crates/rust-analyzer/src/bin/main.rs

+14-4
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,11 @@ use std::{env, fs, path::PathBuf, process::ExitCode, sync::Arc};
1515

1616
use anyhow::Context;
1717
use lsp_server::Connection;
18-
use rust_analyzer::{cli::flags, config::Config, from_json};
18+
use rust_analyzer::{
19+
cli::flags,
20+
config::{Config, ConfigChange, ConfigErrors},
21+
from_json,
22+
};
1923
use semver::Version;
2024
use tracing_subscriber::fmt::writer::BoxMakeWriter;
2125
use vfs::AbsPathBuf;
@@ -220,16 +224,22 @@ fn run_server() -> anyhow::Result<()> {
220224
.filter(|workspaces| !workspaces.is_empty())
221225
.unwrap_or_else(|| vec![root_path.clone()]);
222226
let mut config =
223-
Config::new(root_path, capabilities, workspace_roots, visual_studio_code_version);
227+
Config::new(root_path, capabilities, workspace_roots, visual_studio_code_version, None);
224228
if let Some(json) = initialization_options {
225-
if let Err(e) = config.update(json) {
229+
let mut change = ConfigChange::default();
230+
change.change_client_config(json);
231+
232+
let error_sink: ConfigErrors;
233+
(config, error_sink, _) = config.apply_change(change);
234+
235+
if !error_sink.is_empty() {
226236
use lsp_types::{
227237
notification::{Notification, ShowMessage},
228238
MessageType, ShowMessageParams,
229239
};
230240
let not = lsp_server::Notification::new(
231241
ShowMessage::METHOD.to_owned(),
232-
ShowMessageParams { typ: MessageType::WARNING, message: e.to_string() },
242+
ShowMessageParams { typ: MessageType::WARNING, message: error_sink.to_string() },
233243
);
234244
connection.sender.send(lsp_server::Message::Notification(not)).unwrap();
235245
}

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

+11-1
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,11 @@ use ide_db::LineIndexDatabase;
1010
use load_cargo::{load_workspace_at, LoadCargoConfig, ProcMacroServerChoice};
1111
use rustc_hash::{FxHashMap, FxHashSet};
1212
use scip::types as scip_types;
13+
use tracing::error;
1314

1415
use crate::{
1516
cli::flags,
17+
config::ConfigChange,
1618
line_index::{LineEndings, LineIndex, PositionEncoding},
1719
};
1820

@@ -35,12 +37,20 @@ impl flags::Scip {
3537
lsp_types::ClientCapabilities::default(),
3638
vec![],
3739
None,
40+
None,
3841
);
3942

4043
if let Some(p) = self.config_path {
4144
let mut file = std::io::BufReader::new(std::fs::File::open(p)?);
4245
let json = serde_json::from_reader(&mut file)?;
43-
config.update(json)?;
46+
let mut change = ConfigChange::default();
47+
change.change_client_config(json);
48+
49+
let error_sink;
50+
(config, error_sink, _) = config.apply_change(change);
51+
52+
// FIXME @alibektas : What happens to errors without logging?
53+
error!(?error_sink, "Config Error(s)");
4454
}
4555
let cargo_config = config.cargo();
4656
let (db, vfs, _) = load_workspace_at(

0 commit comments

Comments
 (0)