Deprecate the packageManager setting and automatically detect it with

the vscode command.
microsoft · May 2, 2023 · 35e2a76 · 35e2a76
1 parent d821444
commit 35e2a76
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 14 deletions.
diff --git a/$shared/settings.ts b/$shared/settings.ts
@@ -172,4 +172,4 @@ export type ConfigurationSettings = {
 	nodePath: string | null;
 	workspaceFolder: WorkspaceFolder | undefined;
 	workingDirectory: ModeItem | DirectoryItem | undefined;
-};
+};
diff --git a/README.md b/README.md
@@ -187,7 +187,6 @@ This extension contributes the following variables to the [settings](https://cod
     "eslint.lintTask.options": "-c C:/mydirectory/.eslintrc.json --ignore-path C:/mydirectory/.eslintignore ."
   }
   ```
-- `eslint.packageManager`: controls the package manager to be used to resolve the ESLint library. This has only an influence if the ESLint library is resolved globally. Valid values are `"npm"` or `"yarn"` or `"pnpm"`.
 - `eslint.options`: options to configure how ESLint is started using either the [ESLint class API](http://eslint.org/docs/developer-guide/nodejs-api#eslint-class) or the [CLIEngine API](http://eslint.org/docs/developer-guide/nodejs-api#cliengine). The extension uses the ESLint class API if ESLint version 8 or higher is used or if ESLint version 7 is used and the setting `eslint.useESLintCLass` is set to true. In all other cases the CLIEngine API is used.
   An example to point to a custom `.eslintrc.json` file using the new ESLint API is:
   ```json

diff --git a/client/src/client.ts b/client/src/client.ts
@@ -232,13 +232,15 @@ export namespace ESLintClient {
 			return {};
 		});
 
-		client.onRequest(NoESLintLibraryRequest.type, (params) => {
+		client.onRequest(NoESLintLibraryRequest.type, async (params) => {
 			const key = 'noESLintMessageShown';
 			const state = context.globalState.get<NoESLintState>(key, {});
 
 			const uri: Uri = Uri.parse(params.source.uri);
 			const workspaceFolder = Workspace.getWorkspaceFolder(uri);
-			const packageManager = Workspace.getConfiguration('eslint', uri).get('packageManager', 'npm');
+			const packageManager = await commands.executeCommand<'npm' | 'pnpm' | 'yarn'>(
+				'npm.packageManager'
+			);
 			const localInstall = {
 				npm: 'npm install eslint',
 				pnpm: 'pnpm install eslint',
@@ -934,4 +936,4 @@ export namespace ESLintClient {
 			}
 		}
 	}
-}
+}
diff --git a/history/settings_1_9_x.md b/history/settings_1_9_x.md
@@ -15,7 +15,6 @@ The extension contributes the following variables to the [settings](https://code
     "eslint.lintTask.options": "-c C:/mydirectory/.eslintrc.json --ignore-path C:/mydirectory/.eslintignore ."
   }
   ```
-- `eslint.packageManager`: controls the package manager to be used to resolve the ESLint library. This has only an influence if the ESLint library is resolved globally. Valid values are `"npm"` or `"yarn"` or `"pnpm"`.
 - `eslint.options`: options to configure how ESLint is started using the [ESLint CLI Engine API](http://eslint.org/docs/developer-guide/nodejs-api#cliengine). Defaults to an empty option bag.
   An example to point to a custom `.eslintrc.json` file is:
   ```json
@@ -107,4 +106,4 @@ As with JavaScript validating TypeScript in a mono repository requires that you
 		{ "directory": "./client", "changeProcessCWD": true },
 		{ "directory": "./server", "changeProcessCWD": true }
 	]
-```
+```
diff --git a/package.json b/package.json
@@ -63,7 +63,8 @@
 						"pnpm"
 					],
 					"default": "npm",
-					"description": "The package manager you use to install node modules."
+					"description": "The package manager you use to install node modules.",
+					"deprecationMessage": "The setting is deprecated. The Package Manager is automatically detected now."
 				},
 				"eslint.problems.shortenToSingleLine": {
 					"type": "boolean",

diff --git a/server/src/eslint.ts b/server/src/eslint.ts
@@ -1368,4 +1368,4 @@ export namespace ESLint {
 			return Status.error;
 		}
 	}
-}
+}
diff --git a/server/src/paths.ts b/server/src/paths.ts
@@ -86,11 +86,11 @@ export function getFileSystemPath(uri: URI): string {
 	}
 	if (process.platform === 'win32' || process.platform === 'darwin') {
 		try {
-      const realpath = fs.realpathSync.native(result);
-      // Only use the real path if only the casing has changed.
-      if (realpath.toLowerCase() === result.toLowerCase()) {
-        result = realpath;
-      }
+			const realpath = fs.realpathSync.native(result);
+			// Only use the real path if only the casing has changed.
+			if (realpath.toLowerCase() === result.toLowerCase()) {
+				result = realpath;
+			}
 		} catch {
 			// Silently ignore errors from `fs.realpathSync` to handle scenarios where
 			// the file being linted is not yet written to disk. This occurs in editors
-Original file line number
+Diff line change
@@ Expand Up / @@ -1368,4 +1368,4 @@ export namespace ESLint { @@
     			return Status.error;
     		}
     	}
-    }
+    }