ruff server: Ruff configuration from client settings overrides project configuration
#11062
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
snowsignal
added
configuration
|
|
I'm working on adding some snapshot tests, but the PR should be ready for review regardless. |
MichaReiser
reviewed
Apr 22, 2024
dhruvmanila
approved these changes
Apr 23, 2024
snowsignal
force-pushed
the
jane/server/settings/resolution
branch
from
38b3b60
to
afbfabe
Compare
|
I'll implement snapshot tests as a follow-up |
snowsignal
added a commit
to astral-sh/ruff-vscode
that referenced
this pull request
Apr 25, 2024
## Summary This is a follow-up to astral-sh/ruff#10984, which implemented support for common Ruff configuration options in client settings. This PR exposes these new settings in the extension configuration. These settings are different from other extension settings, because they don't have default values. Instead, if the user does not set them, they will be sent as `null`, and the server will use project configuration instead. At the moment, `ruff server` does not actually resolve these settings yet - settings resolution is introduced in astral-sh/ruff#11062, which means that you'll need to work from that branch to test this PR (and vice-versa). ## Test Plan See the test plan in astral-sh/ruff#11062.
snowsignal
added a commit
that referenced
this pull request
Apr 26, 2024
…er editor configuration (#11086) ## Summary This is intended to address astral-sh/ruff-vscode#425, and is a follow-up to #11062. A new client setting is now supported by the server, `prioritizeFileConfiguration`. This is a boolean setting (default: `false`) that, if set to `true`, will instruct the configuration resolver to prioritize file configuration (aka discovered TOML files) over configuration passed in by the editor. A corresponding extension PR has been opened, which makes this setting available for VS Code: astral-sh/ruff-vscode#457. ## Test Plan To test this with VS Code, you'll need to check out [the VS Code PR](astral-sh/ruff-vscode#457) that adds this setting. The test process is similar to #11062, but in scenarios where the editor configuration would take priority over file configuration, file configuration should take priority.
snowsignal
added a commit
to astral-sh/ruff-vscode
that referenced
this pull request
May 13, 2024
## Summary This is a follow-up to astral-sh/ruff#10984, which implemented support for common Ruff configuration options in client settings. This PR exposes these new settings in the extension configuration. These settings are different from other extension settings, because they don't have default values. Instead, if the user does not set them, they will be sent as `null`, and the server will use project configuration instead. At the moment, `ruff server` does not actually resolve these settings yet - settings resolution is introduced in astral-sh/ruff#11062, which means that you'll need to work from that branch to test this PR (and vice-versa). ## Test Plan See the test plan in astral-sh/ruff#11062.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This is a follow-up to #10984 that implements configuration resolution for editor configuration. By 'editor configuration', I'm referring to the client settings that correspond to Ruff configuration/options, like
preview,select, and so on. These will be combined with 'project configuration' (configuration taken from project files such aspyproject.toml) to generate the final linter and formatter settings used byRuffSettings. Editor configuration takes priority over project configuration.In a follow-up pull request, I'll implement a new client setting that allows project configuration to override editor configuration, as per this issue.
Review guide
The first commit, e38966d, is just doing re-arrangement so that we can pass the right things to
RuffSettings::resolve. The actual resolution logic is in the second commit, 0eec9ee. It might help to look at these comments individually since the diff is rather messy.Test Plan
For the settings to show up in VS Code, you'll need to checkout this branch: astral-sh/ruff-vscode#456.
To test that the resolution for a specific setting works as expected, run through the following scenarios, setting it in project and editor configuration as needed:
An exception to this is
extendSelect, which does not have an analog in TOML configuration. Instead, you should verify thatextendSelectamends theselectsetting. Ifselectis set in both editor and project configuration,extendSelectwill only append to theselectvalue in editor configuration, so make sure to un-set it there if you're testingextendSelectwithselectin project configuration.