From 08ce58fdebff7edf2e669f0153d22205181adcdc Mon Sep 17 00:00:00 2001 From: Steven DeMartini Date: Wed, 1 Mar 2023 13:24:43 -0800 Subject: [PATCH] Fix docs to refer to `fromEnvironment` as default import strategy Closes https://github.com/charliermarsh/ruff-vscode/issues/141 The docs claimed that `useBundled` was the default import strategy, but it seems that's in fact not the case, based on https://github.com/charliermarsh/ruff-vscode/blob/f57ae4f1cad2e7ea3a9caa307898fdfacbd180f1/src/common/settings.ts#L51 Per discussion here https://github.com/charliermarsh/ruff-vscode/issues/141#issuecomment-1450535139, it was agreed to that `fromEnvironment` was the right default, so this updates docs to reflect that existing default. --- README.md | 2 +- package.json | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6c15d72..73fe941 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ per workspace in Visual Studio Code. | logLevel | `error` | Sets the tracing level for the extension. | | path | `[]` | Setting to provide custom `ruff` executables, to try in order. E.g. `["/path/to/ruff"]`. | | interpreter | `[]` | Path to a Python interpreter to use to run the linter server. | -| importStrategy | `useBundled` | Strategy for loading the `ruff` executable. `useBundled` uses the version bundled with the extension. `fromEnvironment` picks up Ruff from the environment, falling back to the bundled version if needed. | +| importStrategy | `fromEnvironment` | Strategy for loading the `ruff` executable. `fromEnvironment` picks up Ruff from the environment, falling back to the bundled version if needed. `useBundled` uses the version bundled with the extension. | | showNotification | `off` | Whether a notification should be shown. | | organizeImports | `true` | Whether to register Ruff as capable of handling `source.organizeImports` actions. | | fixAll | `true` | Whether to register Ruff as capable of handling `source.fixAll` actions. | diff --git a/package.json b/package.json index 0f08dc8..77e8b93 100644 --- a/package.json +++ b/package.json @@ -92,15 +92,15 @@ "type": "array" }, "ruff.importStrategy": { - "default": "useBundled", + "default": "fromEnvironment", "description": "Defines where `ruff` is imported from. This setting may be ignored if `ruff.path` is set.", "enum": [ - "useBundled", - "fromEnvironment" + "fromEnvironment", + "useBundled" ], "enumDescriptions": [ - "Always use the bundled version of `ruff`.", - "Use `ruff` from environment, fallback to bundled version only if `ruff` not available in the environment." + "Use `ruff` from environment, fallback to bundled version only if `ruff` not available in the environment.", + "Always use the bundled version of `ruff`." ], "scope": "window", "type": "string"