Skip to content

Commit

Permalink
Visually demonstrate how to set nativeServer
Browse files Browse the repository at this point in the history
  • Loading branch information
snowsignal committed May 22, 2024
1 parent 3a7bb94 commit 84260d3
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions crates/ruff_server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,29 @@ files in your editor's workspace, and will refresh its in-memory configuration w

We have specific setup instructions depending on your editor. If you don't see your editor on this list and would like a setup guide, please open an issue.

- Visual Studio Code: Install the [Ruff extension from the VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff). **As this server is still in beta, you will need to enable the `Native Server` extension setting**. The language server used by the extension will be, by default, the one in your actively-installed `ruff` binary. If you don't have `ruff` installed and haven't provided a path to the extension, it comes with a bundled `ruff` version that it will use instead.
- Neovim: See the [Neovim setup guide](docs/setup/NEOVIM.md).
- Helix: See the [Helix setup guide](docs/setup//HELIX.md).
#### Visual Studio Code

Install the [Ruff extension from the VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff).

**As this server is still in beta, you will need to enable the `Native Server` extension setting**.

![image](assets/nativeServer.png A screenshot showing an enabled "Native Server" extension setting in the VS Code settings view)

You can also set it in your user / workspace JSON settings as follows:

```json
"ruff.nativeServer": true
```

The language server used by the extension will be, by default, the one in your actively-installed `ruff` binary. If you don't have `ruff` installed and haven't provided a path to the extension, it comes with a bundled `ruff` version that it will use instead.

#### Neovim

See the [Neovim setup guide](docs/setup/NEOVIM.md).

#### Helix

See the [Helix setup guide](docs/setup//HELIX.md).

If you are transferring your configuration from `ruff-lsp`, regardless of editor, there are several settings which have changed or are no longer available which you should be aware of. See the [migration guide](docs/MIGRATION.md) for more details.

Expand Down
Binary file added crates/ruff_server/assets/nativeServer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 84260d3

Please sign in to comment.