mirror of
https://github.com/astral-sh/ruff.git
synced 2025-07-27 15:03:51 +00:00
50739f91dc
This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [mdformat-mkdocs](https://redirect.github.com/kyleking/mdformat-mkdocs) ([changelog](https://redirect.github.com/kyleking/mdformat-mkdocs/releases)) | `==3.1.1` -> `==4.0.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>kyleking/mdformat-mkdocs (mdformat-mkdocs)</summary> ### [`v4.0.0`](https://redirect.github.com/KyleKing/mdformat-mkdocs/releases/tag/v4.0.0) [Compare Source](https://redirect.github.com/kyleking/mdformat-mkdocs/compare/v3.1.1...v4.0.0) #### What's Changed - fix!: add newline after title for consistency with MKDocs style by [@​KyleKing](https://redirect.github.com/KyleKing) in [https://github.com/KyleKing/mdformat-mkdocs/pull/44](https://redirect.github.com/KyleKing/mdformat-mkdocs/pull/44) **Full Changelog**: https://github.com/KyleKing/mdformat-mkdocs/compare/v3.1.1...v4.0.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 4am on Monday" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/astral-sh/ruff). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS41OC4xIiwidXBkYXRlZEluVmVyIjoiMzkuNTguMSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiaW50ZXJuYWwiXX0=--> --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com> Co-authored-by: Kyle King <KyleKing@users.noreply.github.com>
83 lines
2.6 KiB
Markdown
83 lines
2.6 KiB
Markdown
# Migrating from `ruff-lsp`
|
|
|
|
While `ruff server` supports the same feature set as [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp), migrating to
|
|
`ruff server` may require changes to your Ruff or language server configuration.
|
|
|
|
!!! note
|
|
|
|
The [VS Code extension](https://github.com/astral-sh/ruff-vscode) settings include documentation to indicate which
|
|
settings are supported by `ruff server`. As such, this migration guide is primarily targeted at editors that lack
|
|
explicit documentation for `ruff server` settings, such as Helix or Neovim.
|
|
|
|
## Unsupported Settings
|
|
|
|
Several `ruff-lsp` settings are not supported by `ruff server`. These are, as follows:
|
|
|
|
- `format.args`
|
|
- `ignoreStandardLibrary`
|
|
- `interpreter`
|
|
- `lint.args`
|
|
- `lint.run`
|
|
- `path`
|
|
|
|
!!! note
|
|
|
|
Some of these settings, like `interpreter` and `path`, are still accepted by the VS Code
|
|
extension. `path`, in particular, can be used to specify a dedicated binary to use when
|
|
initializing `ruff server`. But the language server itself will no longer accept such settings.
|
|
|
|
## New Settings
|
|
|
|
`ruff server` introduces several new settings that `ruff-lsp` does not have. These are, as follows:
|
|
|
|
- [`configuration`](settings.md#configuration)
|
|
- [`configurationPreference`](settings.md#configurationpreference)
|
|
- [`exclude`](settings.md#exclude)
|
|
- [`format.preview`](settings.md#format_preview)
|
|
- [`lineLength`](settings.md#linelength)
|
|
- [`lint.select`](settings.md#select)
|
|
- [`lint.extendSelect`](settings.md#extendselect)
|
|
- [`lint.ignore`](settings.md#ignore)
|
|
- [`lint.preview`](settings.md#lint_preview)
|
|
|
|
Several of these new settings are replacements for the now-unsupported `format.args` and `lint.args`. For example, if
|
|
you've been passing `--select=<RULES>` to `lint.args`, you can migrate to the new server by using `lint.select` with a
|
|
value of `["<RULES>"]`.
|
|
|
|
## Examples
|
|
|
|
Let's say you have these settings in VS Code:
|
|
|
|
```json
|
|
{
|
|
"ruff.lint.args": "--select=E,F --line-length 80 --config ~/.config/custom_ruff_config.toml"
|
|
}
|
|
```
|
|
|
|
After enabling the native server, you can migrate your settings like so:
|
|
|
|
```json
|
|
{
|
|
"ruff.configuration": "~/.config/custom_ruff_config.toml",
|
|
"ruff.lineLength": 80,
|
|
"ruff.lint.select": ["E", "F"]
|
|
}
|
|
```
|
|
|
|
Similarly, let's say you have these settings in Helix:
|
|
|
|
```toml
|
|
[language-server.ruff.config.lint]
|
|
args = "--select=E,F --line-length 80 --config ~/.config/custom_ruff_config.toml"
|
|
```
|
|
|
|
These can be migrated like so:
|
|
|
|
```toml
|
|
[language-server.ruff.config]
|
|
configuration = "~/.config/custom_ruff_config.toml"
|
|
lineLength = 80
|
|
|
|
[language-server.ruff.config.lint]
|
|
select = ["E", "F"]
|
|
```
|