Skip to content

Commit 1f82731

Browse files
authored
Use CWD to resolve settings from ruff.configuration (#14352)
## Summary This PR fixes a bug in the Ruff language server where the editor-specified configuration was resolved relative to the configuration directory and not the current working directory. The existing behavior is confusing given that this config file is specified by the user and is not _discovered_ by Ruff itself. The behavior of resolving this configuration file should be similar to that of the `--config` flag on the command-line which uses the current working directory: https://github.com/astral-sh/ruff/blob/3210f1a23bfe42c5d58c609b602861062eeed2ad/crates/ruff/src/resolve.rs#L34-L48 This creates problems where certain configuration options doesn't work because the paths resolved in that case are relative to the configuration directory and not the current working directory in which the editor is expected to be in. For example, the `lint.per-file-ignores` doesn't work as mentioned in the linked issue along with `exclude`, `extend-exclude`, etc. fixes: #14282 ## Test Plan Using the following directory tree structure: ``` . ├── .config │   └── ruff.toml └── src └── migrations └── versions └── a.py ``` where, the `ruff.toml` is: ```toml # 1. Comment this out to test `per-file-ignores` extend-exclude = ["**/versions/*.py"] [lint] select = ["D"] # 2. Comment this out to test `extend-exclude` [lint.per-file-ignores] "**/versions/*.py" = ["D"] # 3. Comment both `per-file-ignores` and `extend-exclude` to test selection works ``` And, the content of `a.py`: ```py """Test""" ``` And, the VS Code settings: ```jsonc { "ruff.nativeServer": "on", "ruff.path": ["/Users/dhruv/work/astral/ruff/target/debug/ruff"], // For single-file mode where current working directory is `/` // "ruff.configuration": "/tmp/ruff-repro/.config/ruff.toml", // When a workspace is opened containing this path "ruff.configuration": "./.config/ruff.toml", "ruff.trace.server": "messages", "ruff.logLevel": "trace" } ``` I also tested out just opening the file in single-file mode where the current working directory is `/` in VS Code. Here, the `ruff.configuration` needs to be updated to use absolute path as shown in the above VS Code settings.
1 parent 874da9c commit 1f82731

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

crates/ruff_server/src/session/index/ruff_settings.rs

+5-1
Original file line numberDiff line numberDiff line change
@@ -380,6 +380,10 @@ impl<'a> ConfigurationTransformer for EditorConfigurationTransformer<'a> {
380380

381381
// Merge in the editor-specified configuration file, if it exists.
382382
let editor_configuration = if let Some(config_file_path) = configuration {
383+
tracing::debug!(
384+
"Combining settings from editor-specified configuration file at: {}",
385+
config_file_path.display()
386+
);
383387
match open_configuration_file(&config_file_path) {
384388
Ok(config_from_file) => editor_configuration.combine(config_from_file),
385389
Err(err) => {
@@ -406,7 +410,7 @@ impl<'a> ConfigurationTransformer for EditorConfigurationTransformer<'a> {
406410
fn open_configuration_file(config_path: &Path) -> crate::Result<Configuration> {
407411
ruff_workspace::resolver::resolve_configuration(
408412
config_path,
409-
Relativity::Parent,
413+
Relativity::Cwd,
410414
&IdentityTransformer,
411415
)
412416
}

0 commit comments

Comments
 (0)