Allow setting pylsp.plugins.ruff.format to ["ALL"]
#101
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
In this case, the ignore will take precedence and setting `pylsp.plugins.ruff.format` to `["ALL"]` will do nothing.
Update existing test text to be compatible with the case that a format is run with `format` set to `["ALL"]`.
willjow
commented
Oct 25, 2024
| @@ -142,7 +142,7 @@ def pylsp_format_document(workspace: Workspace, document: Document) -> Generator | |||
| # specifying `format = ["I"]` to get import sorting as part of formatting. | |||
| new_text = run_ruff( | |||
| settings=PluginSettings( | |||
| ignore=["ALL"], | |||
| ignore=["ALL"] if "ALL" not in settings.format else [], | |||
There was a problem hiding this comment.
This is admittedly a bit of a quick and dirty patch; would it be preferred to track this condition when the settings are parsed?
| @@ -121,3 +127,22 @@ def test_ruff_format_and_sort_imports(workspace): | |||
| ) | |||
| got = run_plugin_format(workspace, doc) | |||
| assert want == got | |||
|
|
|||
|
|
|||
| def test_ruff_format_via_all(workspace): | |||
There was a problem hiding this comment.
This is somewhat of a fragile thing to test since it's at the mercy of whatever rules ruff might add. The tested text might be reasonably robust, but it also might be best to just leave this out.
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.
I'm a new user of ruff, so apologies if this is not intended usage!
When setting up my ruff config, I thought it might be fun to aggressively format using all of ruff's rules in the absence of any project settings.
However, it appears that the
ignoreoption dominates theselectoption forruff checkif the same rule code is specified in each. Thus, the plugin will not currently work as expected ifpylsp.plugins.ruff.formatis set to["ALL"].