Enable running extension on-save only (#220)

## Summary

Now supported in the LSP
(astral-sh/ruff-lsp#146): The API exactly mimics
that of the [ESLint
extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint):
we have a new setting, `run`, that accepts either `onType` (default) or
`onSave`.

Closes #110.

Author: charliermarsh

README.md

@@ -45,6 +45,7 @@ per workspace in Visual Studio Code.
 | path             | `[]`              | Path to a custom `ruff` executable, e.g., `["/path/to/ruff"]`.                                                                                                                                                                                              |
 | interpreter      | `[]`              | Path to a Python interpreter to use to run the linter server.                                                                                                                                                                                               |
 | 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.                                                  |
+| run              | `onType`          | Run Ruff on every keystroke (`onType`) or on save (`onSave`).                                                                                                                                                                                               |
 | showNotification | `off`             | Setting to control when a notification is 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.                                                                                                                                                                                    |

package.json

@@ -100,6 +100,20 @@
           "scope": "window",
           "type": "string"
         },
+        "ruff.run": {
+          "default": "onType",
+          "description": "Run Ruff on every keystroke (`onType`) or on save (`onSave`).",
+          "enum": [
+            "onType",
+            "onSave"
+          ],
+          "enumDescriptions": [
+            "Run Ruff on every keystroke.",
+            "Run Ruff on save."
+          ],
+          "scope": "window",
+          "type": "string"
+        },
         "ruff.interpreter": {
           "default": [],
           "description": "When set to a path to python executable, extension will use that to launch the server and any subprocess.",

src/common/server.ts

@@ -75,9 +75,6 @@ export async function createServer(
   const cwd = getProjectRoot()?.uri.fsPath;
   const newEnv = { ...process.env };
 
-  // Set import strategy.
-  newEnv.LS_IMPORT_STRATEGY = settings.importStrategy;
-
   // Set notification type.
   newEnv.LS_SHOW_NOTIFICATION = settings.showNotifications;
 

src/common/settings.ts

@@ -3,13 +3,18 @@ import { getInterpreterDetails } from "./python";
 import { LoggingLevelSettingType } from "./log/types";
 import { getConfiguration, getWorkspaceFolders } from "./vscodeapi";
 
+type ImportStrategy = "fromEnvironment" | "useBundled";
+
+type Run = "onType" | "onSave";
+
 export interface ISettings {
   workspace: string;
   logLevel: LoggingLevelSettingType;
   args: string[];
   path: string[];
   interpreter: string[];
-  importStrategy: string;
+  importStrategy: ImportStrategy;
+  run: Run;
   showNotifications: string;
   organizeImports: boolean;
   fixAll: boolean;
@@ -51,7 +56,8 @@ export async function getWorkspaceSettings(
     args: config.get<string[]>(`args`) ?? [],
     path: config.get<string[]>(`path`) ?? [],
     interpreter: interpreter ?? [],
-    importStrategy: config.get<string>(`importStrategy`) ?? "fromEnvironment",
+    importStrategy: config.get<ImportStrategy>(`importStrategy`) ?? "fromEnvironment",
+    run: config.get<Run>(`run`) ?? "onType",
     showNotifications: config.get<string>(`showNotifications`) ?? "off",
     organizeImports: config.get<boolean>(`organizeImports`) ?? true,
     fixAll: config.get<boolean>(`fixAll`) ?? true,
@@ -68,7 +74,8 @@ export async function getGlobalSettings(namespace: string): Promise<Omit<ISettin
     args: config.get<string[]>(`args`) ?? [],
     path: config.get<string[]>(`path`) ?? [],
     interpreter: interpreter ?? [],
-    importStrategy: config.get<string>(`importStrategy`) ?? "fromEnvironment",
+    importStrategy: config.get<ImportStrategy>(`importStrategy`) ?? "fromEnvironment",
+    run: config.get<Run>(`run`) ?? "onType",
     showNotifications: config.get<string>(`showNotifications`) ?? "off",
     organizeImports: config.get<boolean>(`organizeImports`) ?? true,
     fixAll: config.get<boolean>(`fixAll`) ?? true,
@@ -85,6 +92,7 @@ export function checkIfConfigurationChanged(
     `${namespace}.path`,
     `${namespace}.interpreter`,
     `${namespace}.importStrategy`,
+    `${namespace}.run`,
     `${namespace}.showNotifications`,
     `${namespace}.organizeImports`,
     `${namespace}.fixAll`,