Skip to content

Commit

Permalink
Add README section for untrusted workspace support
Browse files Browse the repository at this point in the history
  • Loading branch information
dhruvmanila committed Jul 17, 2024
1 parent 419204b commit 2220d02
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,22 @@ This requires Ruff version `v0.1.3` or later.

[notebook document synchronization]: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notebookDocument_synchronization

## Untrusted Workspace

_New in v2024.32.0_

The extension supports loading in an [untrusted workspace](https://code.visualstudio.com/docs/editor/workspace-trust).
When the workspace is untrusted, the extension will always use the Rust-based language server even if the `nativeServer`
setting is set to `off`. This is because the Python-based language server requires a Python interpreter to run, which
is not allowed in an untrusted workspace. This also means that the extension will always use the bundled executable of
the `ruff` binary regardless of any other settings.

The following settings are not supported in an untrusted workspace:
* `ruff.configuration`
* `ruff.importStrategy`
* `ruff.interpreter`
* `ruff.path`

## Settings

Refer to the [Ruff Language Server documentation](https://docs.astral.sh/ruff/server/settings/) for a full list of
Expand Down

0 comments on commit 2220d02

Please sign in to comment.