feat: resolve plugins path in symlink node_modules structure dirs (p…

…rettier#2566)

* feat: support symlink `node_modules` structure load plugin

* test: add test for pnpm scene

* docs: add changelog

* chore: remove temp data

.github/workflows/main.yml

@@ -10,6 +10,10 @@ jobs:
         os: [windows-latest, ubuntu-latest, macos-latest]
     name: Test on ${{ matrix.os }}
     steps:
+      - uses: pnpm/[email protected]
+        with:
+          version: 7
+          run_install: false
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:

package.json

@@ -70,7 +70,7 @@
   "scripts": {
     "clean": "node ./scripts/clean.js",
     "lint": "eslint -c .eslintrc.js --ext .ts .",
-    "pretest": "yarn test-compile && cd test-fixtures/plugins && yarn install && cd ../outdated && yarn install && cd ../module && yarn install && cd ../specific-version && yarn install && cd ../explicit-dep && yarn install && cd implicit-dep && yarn install",
+    "pretest": "yarn test-compile && cd test-fixtures/plugins && yarn install && cd ../plugins-pnpm && pnpm i && cd ../outdated && yarn install && cd ../module && yarn install && cd ../specific-version && yarn install && cd ../explicit-dep && yarn install && cd implicit-dep && yarn install",
     "prettier": "prettier --write '**/*.{ts,json,md,hbs,yml,js}'",
     "test-compile": "yarn clean && tsc -p ./ && yarn webpack",
     "test": "node ./out/test/runTests.js",

src/ModuleResolver.ts

@@ -302,6 +302,10 @@ export class ModuleResolver implements ModuleResolverInterface {
       );
     }
 
+    if (resolvedConfig) {
+      resolvedConfig = this.resolveConfigPlugins(resolvedConfig, fileName);
+    }
+
     if (!isVirtual && !resolvedConfig && vscodeConfig.requireConfig) {
       this.loggingService.logInfo(
         "Require config set to true and no config present. Skipping file."
@@ -326,14 +330,16 @@ export class ModuleResolver implements ModuleResolverInterface {
     this.path2Module.clear();
   }
 
+  private get nodeModuleLoader() {
+    return typeof __webpack_require__ === "function"
+      ? __non_webpack_require__
+      : require;
+  }
+
   // Source: https://github.com/microsoft/vscode-eslint/blob/master/server/src/eslintServer.ts
   private loadNodeModule<T>(moduleName: string): T | undefined {
-    const r =
-      typeof __webpack_require__ === "function"
-        ? __non_webpack_require__
-        : require;
     try {
-      return r(moduleName);
+      return this.nodeModuleLoader(moduleName);
     } catch (error) {
       this.loggingService.logError(
         `Error loading node module '${moduleName}'`,
@@ -343,6 +349,43 @@ export class ModuleResolver implements ModuleResolverInterface {
     return undefined;
   }
 
+  private resolveNodeModule(moduleName: string, options?: { paths: string[] }) {
+    try {
+      return this.nodeModuleLoader.resolve(moduleName, options);
+    } catch (error) {
+      this.loggingService.logError(
+        `Error resolve node module '${moduleName}'`,
+        error
+      );
+    }
+    return undefined;
+  }
+
+  /**
+   * Resolve plugin package path for symlink structure dirs
+   * See https://github.com/prettier/prettier/issues/8056
+   */
+  private resolveConfigPlugins(
+    config: PrettierOptions,
+    fileName: string
+  ): PrettierOptions {
+    if (config?.plugins?.length) {
+      config.plugins = config.plugins.map((plugin) => {
+        if (
+          typeof plugin === "string" &&
+          !plugin.startsWith(".") &&
+          !path.isAbsolute(plugin)
+        ) {
+          return (
+            this.resolveNodeModule(plugin, { paths: [fileName] }) || plugin
+          );
+        }
+        return plugin;
+      });
+    }
+    return config;
+  }
+
   private isInternalTestRoot(dir: string): boolean {
     if (process.env.NODE_ENV !== "production") {
       // This is for testing purposes only. This code is removed in the

src/test/suite/plugins.test.ts

@@ -8,4 +8,10 @@ suite("Test plugins", function () {
     const expected = await getText("plugins", "index.result.php");
     assert.equal(actual, expected);
   });
+
+  test("it correctly resolved plugin in pnpm node_modules dirs structure", async () => {
+    const { actual } = await format("plugins-pnpm", "index.js");
+    const expected = await getText("plugins-pnpm", "index.result.js");
+    assert.equal(actual, expected);
+  });
 });

test-fixtures/plugins-pnpm/.prettierrc

@@ -0,0 +1,3 @@
+{
+  "plugins": ["prettier-plugin-organize-imports"]
+}

test-fixtures/plugins-pnpm/index.js

@@ -0,0 +1,2 @@
+import   'prettier'
+import { a } from './unused-module'

test-fixtures/plugins-pnpm/index.result.js

@@ -0,0 +1 @@
+import "prettier";

test-fixtures/plugins-pnpm/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "plugins-pnpm",
+  "version": "1.0.0",
+  "description": "Test resolve plugin in pnpm",
+  "private": true,
+  "devDependencies": {
+    "prettier": "^2.6.2",
+    "prettier-plugin-organize-imports": "2.3.4"
+  },
+  "pnpm": {
+    "peerDependencyRules": {
+      "ignoreMissing": ["typescript"]
+    }
+  }
+}

test-fixtures/plugins-pnpm/unused-module.js

@@ -0,0 +1 @@
+export const a = 1

test-fixtures/test.code-workspace

@@ -12,6 +12,9 @@
     {
       "path": "plugins"
     },
+    {
+      "path": "plugins-pnpm"
+    },
     {
       "path": "config"
     },