Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce ruff.printDebugInformation command #495

Merged
merged 2 commits into from
Jun 13, 2024
Merged

Conversation

snowsignal
Copy link
Member

Summary

Introduces a command to print debug information. It should look like this in the Output window:

Screenshot 2024-06-10 at 12 21 07 PM

Test Plan

See astral-sh/ruff#11831 for testing information.

src/extension.ts Outdated Show resolved Hide resolved
snowsignal added a commit to astral-sh/ruff that referenced this pull request Jun 11, 2024
…1831)

## Summary

Closes #11715.

Introduces a new command, `ruff.printDebugInformation`. This will print
useful information about the status of the server to `stderr`.

Right now, the information shown by this command includes:
* The path to the server executable
* The version of the executable
* The text encoding being used
* The number of open documents and workspaces
* A list of registered configuration files
* The capabilities of the client

## Test Plan

First, checkout and use [the corresponding `ruff-vscode`
PR](astral-sh/ruff-vscode#495).

Running the `Print debug information` command in VS Code should show
something like the following in the Output channel:

<img width="991" alt="Screenshot 2024-06-11 at 11 41 46 AM"
src="https://github.com/astral-sh/ruff/assets/19577865/ab93c009-bb7b-4291-b057-d44fdc6f9f86">
@snowsignal
Copy link
Member Author

I've updated the command handler to ignore the command when we're using ruff-lsp (and I've added (name server only) to the command to make this more clear).

@snowsignal snowsignal merged commit c522868 into main Jun 13, 2024
6 checks passed
@snowsignal snowsignal deleted the jane/command/debug branch June 13, 2024 19:30
Comment on lines +194 to +195
// let configuration = getConfiguration(serverId) as ISettings;

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a leftover? ;)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, I'll remove that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants