You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update migration guide with the new ruff.configuration (#16567)
## Summary
This PR updates the migration guide to use the new `ruff.configuration`
settings update to provide a better experience.
### Preview
<details><summary>Migration page screenshot</summary>
<p>

</p>
</details>
To provide some context, [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp) is the LSP implementation for Ruff to power the editor
4
-
integrations which is written in Python and is a separate package from Ruff itself. The **native
5
-
server**is the LSP implementation which is written in Rust and is available under the `ruff server`
6
-
command. This guide is intended to help users migrate from
7
-
[`ruff-lsp`](https://github.com/astral-sh/ruff-lsp) to the native server.
3
+
[`ruff-lsp`][ruff-lsp] is the [Language Server Protocol] implementation for Ruff to power the editor
4
+
integrations. It is written in Python and is a separate package from Ruff itself. The **native
5
+
server**, however, is the [Language Server Protocol]implementation which is **written in Rust** and
6
+
is available under the `ruff server`command. This guide is intended to help users migrate from
7
+
[`ruff-lsp`][ruff-lsp] to the native server.
8
8
9
9
!!! note
10
10
11
-
The native server was first introduced in Ruff version `0.3.5`. It was marked as beta in version
12
-
`0.4.5` and officially stabilized in version `0.5.3`. It is recommended to use the latest
13
-
version of Ruff to ensure the best experience.
11
+
The native server was first introduced in Ruff version `0.3.5`. It was marked as [beta in
12
+
version `0.4.5`](https://astral.sh/blog/ruff-v0.4.5) and officially [stabilized in version
13
+
`0.5.3`](https://github.com/astral-sh/ruff/releases/tag/0.5.3). It is recommended to use the
14
+
latest version of Ruff to ensure the best experience.
14
15
15
16
The migration process involves any or all of the following:
16
17
17
18
1. Migrate [deprecated settings](#unsupported-settings) to the [new settings](#new-settings)
18
19
1.[Remove settings](#removed-settings) that are no longer supported
19
20
1. Update the `ruff` version
20
21
22
+
Read on to learn more about the unsupported or new settings, or jump to the [examples](#examples)
23
+
that enumerate some of the common settings and how to migrate them.
24
+
21
25
## Unsupported Settings
22
26
23
-
The following [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp) settings are not supported by `ruff server`:
27
+
The following [`ruff-lsp`][ruff-lsp] settings are not supported by the native server:
24
28
25
-
-`lint.run`: This setting is no longer relevant for the native language server, which runs on every
26
-
keystroke by default.
27
-
-`lint.args`, `format.args`: These settings have been replaced by more granular settings in `ruff server` like [`lint.select`](settings.md#select), [`format.preview`](settings.md#format_preview),
28
-
etc. along with the ability to provide a default configuration file using [`configuration`](settings.md#configuration).
29
+
-[`lint.run`](settings.md#lintrun): This setting is no longer relevant for the native language
30
+
server, which runs on every keystroke by default.
31
+
-[`lint.args`](settings.md#lintargs), [`format.args`](settings.md#formatargs): These settings have
32
+
been replaced by more granular settings in the native server like [`lint.select`](settings.md#select),
33
+
[`format.preview`](settings.md#format_preview), etc. along with the ability to override any
34
+
configuration using the [`configuration`](settings.md#configuration) setting.
29
35
30
-
The following settings are not accepted by the language server but are still used by the VS Code
31
-
extension. Refer to their respective documentation for more information on how it's being used by
32
-
the extension:
36
+
The following settings are not accepted by the language server but are still used by the [VS Code extension].
37
+
Refer to their respective documentation for more information on how each is used by the extension:
33
38
34
39
-[`path`](settings.md#path)
35
40
-[`interpreter`](settings.md#interpreter)
36
41
37
42
## Removed Settings
38
43
39
-
Additionally, the following settings are not supported by the native server, they should be removed:
44
+
Additionally, the following settings are not supported by the native server and should be removed:
0 commit comments