ruff server: Introduce the ruff.printDebugInformation command
#11831
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
|
MichaReiser
approved these changes
Jun 11, 2024
There was a problem hiding this comment.
This is excellent! Do we have a place where we could document the new command? Like, have an issue, run this command and create an issue in the RUff repository.
Would it be possible to show the user a message hinting them that they should look at the output panel? It may otherwise not be clear where they can find the debug output
dhruvmanila
approved these changes
Jun 11, 2024
dhruvmanila
reviewed
Jun 11, 2024
|
Considering a command that could be added to vsc? Using the C-S-p command center
|
|
@rainzee I think astral-sh/ruff-vscode#495 does that. |
dhruvmanila
added a commit
that referenced
this pull request
Jun 13, 2024
## Summary This PR updates the server capabilities to include the commands that Ruff supports. This is similar to how there's a list of possible code actions supported by the server. I noticed this when I was trying to find whether Helix supported workspace commands or not based on Jane's comment (#11831 (comment)) and I found the `:lsp-workspace-command` in the editor but it didn't show up anything in the picker. So, I looked at the implementation in Helix (https://github.com/helix-editor/helix/blob/9c479e6d2de3bca9dec304f9182cee2b1c0ad766/helix-term/src/commands/typed.rs#L1372-L1384) which made me realize that Ruff doesn't provide this in its capabilities. Currently, this does require `ruff` to be first in the list of language servers in the user config but that should be resolved by helix-editor/helix#10176. So, the following config should work: ```toml [[language]] name = "python" # Ruff should come first until helix-editor/helix#10176 is released language-servers = ["ruff", "pyright"] ``` ## Test Plan 1. Neovim's server capabilities output should include the supported commands: ``` executeCommandProvider = { commands = { "ruff.applyFormat", "ruff.applyAutofix", "ruff.applyOrganizeImports", "ruff.printDebugInformation" }, workDoneProgress = false }, ``` 2. Helix should now display the commands to pick from when `:lsp-workspace-command` is invoked: <img width="832" alt="Screenshot 2024-06-13 at 08 47 14" src="https://github.com/astral-sh/ruff/assets/67177269/09048ecd-c974-4e09-ab56-9482ff3d780b">
snowsignal
added a commit
to astral-sh/ruff-vscode
that referenced
this pull request
Jun 13, 2024
## Summary Introduces a command to print debug information. It should look like this in the Output window: <img width="632" alt="Screenshot 2024-06-10 at 12 21 07 PM" src="https://github.com/astral-sh/ruff-vscode/assets/19577865/671c38a0-00f6-4fd1-a4e6-824cc788b54f"> ## Test Plan See astral-sh/ruff#11831 for testing information.
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
Closes #11715.
Introduces a new command,
ruff.printDebugInformation. This will print useful information about the status of the server tostderr.Right now, the information shown by this command includes:
Test Plan
First, checkout and use the corresponding
ruff-vscodePR.Running the
Print debug informationcommand in VS Code should show something like the following in the Output channel: