Move args and run settings to lint.args and lint.run
#255
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
charliermarsh
force-pushed
the
charlie/lint-settings
branch
from
f034d0e to
3588ca2
Compare
konstin
approved these changes
Oct 2, 2023
| @@ -2,16 +2,15 @@ | |||
|
|
|||
| from typing_extensions import Literal, TypedDict | |||
|
|
|||
| Run = Literal["onSave", "onType"] | |||
There was a problem hiding this comment.
Maybe RunOn or RunTrigger or something else less generic
charliermarsh
force-pushed
the
charlie/lint-settings
branch
from
3588ca2 to
9b3b32c
Compare
charliermarsh
added a commit
to astral-sh/ruff-vscode
that referenced
this pull request
Oct 2, 2023
## Summary This is the peer PR to astral-sh/ruff-lsp#255, adding `ruff.lint.args` and `ruff.lint.run` to the VS Code settings. Again, these changes are backwards-compatible, and the deprecations are also visible in the VS Code UI. (Specifically, according to the [VS Code documentation](https://code.visualstudio.com/api/references/contribution-points), these settings _won't_ show up in the VS Code UI.)
charliermarsh
added a commit
to astral-sh/ruff-vscode
that referenced
this pull request
Oct 2, 2023
## Summary This is the peer PR to astral-sh/ruff-lsp#255, which adds `lint.args` and `lint.run` to the VS Code extension, and deprecates `args` and `run`: <img width="582" alt="Screen Shot 2023-10-02 at 3 07 32 PM" src="https://github.com/astral-sh/ruff-vscode/assets/1309177/68188078-ada1-4060-a8bb-3a734183f5e3"> The behavior is as follows: - If you have `lint.run` defined in your settings, we will respect it and ignore `run`. - Otherwise, if you have `run` defined in your settings, we will respect it. - Otherwise, we fall back to the default value. Confusingly, if you set `run`, VS Code _still_ doesn't show it in the visual settings UI, which is unfortunate, as one edge case here is: - You have `run` defined. - You set `lint.run` in the visual UI. - (`run` is still defined in your `settings.json`, but not visible in the UI.) - You unset `lint.run` in the visual UI. - (VS Code then removes `lint.run` from your `settings.json`, since it now matches the default value and is unnecessary.) - Now, you're using the old `run` setting even though it's not visible in the UI. I'm not sure if there's a great way around this. We could consider showing a warning, but that might be somewhat intrusive? ## Test Plan Extensive local testing 😅
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 PR moves the
argsandrunsettings under alintnamespace, in a backwards-compatible way, such that we continue to respect existing configurations.These settings only affect the linter and not the formatter. In particular, this will enable us to add
format.argsin the future, forruff formatcommand-line arguments.