mirror of https://github.com/astral-sh/ruff.git synced 2025-08-04 02:38:25 +00:00

History

Dhruv Manilawala 1f82731856 Some checks are pending CI / Determine changes (push) Waiting to run Details CI / cargo fmt (push) Waiting to run Details CI / cargo clippy (push) Blocked by required conditions Details CI / cargo test (linux) (push) Blocked by required conditions Details CI / cargo test (windows) (push) Blocked by required conditions Details CI / cargo test (wasm) (push) Blocked by required conditions Details CI / cargo build (release) (push) Blocked by required conditions Details CI / cargo build (msrv) (push) Blocked by required conditions Details CI / cargo fuzz (push) Blocked by required conditions Details CI / Fuzz the parser (push) Blocked by required conditions Details CI / test scripts (push) Blocked by required conditions Details CI / ecosystem (push) Blocked by required conditions Details CI / cargo shear (push) Blocked by required conditions Details CI / python package (push) Waiting to run Details CI / pre-commit (push) Waiting to run Details CI / mkdocs (push) Waiting to run Details CI / formatter instabilities and black similarity (push) Blocked by required conditions Details CI / test ruff-lsp (push) Blocked by required conditions Details CI / benchmarks (push) Blocked by required conditions Details 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: `3210f1a23b/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.		2024-11-15 13:45:00 +05:30
..
assets
docs
resources/test/fixtures
src	Use CWD to resolve settings from `ruff.configuration` (#14352 )	2024-11-15 13:45:00 +05:30
tests	Enable nursery rules: 'redundant_clone', 'debug_assert_with_mut_call', and 'unused_peekable' (#13920 )	2024-10-25 09:46:30 +02:00
Cargo.toml
CONTRIBUTING.md
README.md

README.md

The Ruff Language Server

ruff server is a language server that powers Ruff's editor integrations.

The job of the language server is to listen for requests from the client (in this case, the code editor of your choice) and call into Ruff's linter and formatter crates to construct real-time diagnostics or formatted code, which is then sent back to the client. It also tracks configuration files in your editor's workspace, and will refresh its in-memory configuration whenever those files are modified.

Refer to the documentation for more information on how to set up the language server with your editor and configure it to your liking.

Contributing

Contributions are welcome and highly appreciated. To get started, check out the contributing guidelines.

You can also join us on Discord.