ModuleResolver: Add some unit tests (#1305)

* ModuleResolver: Add some unit tests

Add .prettier-vscode-root file, largely for testing purposes

* ModuleResolver: update path regex to be platform independent

src/ModuleResolver.ts

@@ -334,6 +334,10 @@ export class ModuleResolver implements Disposable {
         if (fs.existsSync(path.join(dir, "node_modules", pkgName))) {
           return dir;
         }
+
+        if (fs.existsSync(path.join(dir, ".prettier-vscode-root"))) {
+          return findUp.stop;
+        }
       },
       { cwd: finalPath, type: "directory" }
     );

src/test/suite/ModuleResolver.test.ts

@@ -0,0 +1,91 @@
+import * as assert from "assert";
+import * as path from "path";
+import * as prettier from "prettier";
+// tslint:disable-next-line: no-implicit-dependencies
+import * as sinon from "sinon";
+
+import { getWorkspaceFolderUri } from "./format.test";
+import { ModuleResolver } from "../../ModuleResolver";
+import { LoggingService } from "../../LoggingService";
+import { NotificationService } from "../../NotificationService";
+
+suite("Test ModuleResolver", function () {
+  let moduleResolver: ModuleResolver;
+  let logErrorSpy: sinon.SinonSpy;
+  let logInfoSpy: sinon.SinonSpy;
+
+  this.beforeEach(() => {
+    const loggingService = new LoggingService();
+    logErrorSpy = sinon.spy(loggingService, "logError");
+    logInfoSpy = sinon.spy(loggingService, "logInfo");
+    const notificationService = new NotificationService(loggingService);
+
+    moduleResolver = new ModuleResolver(loggingService, notificationService);
+  });
+
+  suite("getPrettierInstance", () => {
+    test("it returns the bundled version of Prettier if local isn't found", () => {
+      const fileName = path.join(
+        getWorkspaceFolderUri("no-dep").fsPath,
+        "index.js"
+      );
+      const prettierInstance = moduleResolver.getPrettierInstance(fileName, {
+        showNotifications: true,
+      });
+
+      assert.equal(prettierInstance, prettier);
+      assert(logInfoSpy.calledWith("Using bundled version of prettier."));
+    });
+
+    test("it returns the bundled version of Prettier if local is outdated", () => {
+      const fileName = path.join(
+        getWorkspaceFolderUri("outdated").fsPath,
+        "ugly.js"
+      );
+      const prettierInstance = moduleResolver.getPrettierInstance(fileName);
+
+      assert.equal(prettierInstance, prettier);
+      assert(
+        logErrorSpy.calledWith(
+          "Outdated version of prettier installed. Falling back to bundled version of prettier."
+        )
+      );
+    });
+
+    test("it returns prettier version from package.json", () => {
+      const fileName = path.join(
+        getWorkspaceFolderUri("eslint").fsPath,
+        "index.js"
+      );
+      const prettierInstance = moduleResolver.getPrettierInstance(fileName);
+
+      assert.notEqual(prettierInstance, prettier);
+      assert.equal(prettierInstance.version, "2.0.2");
+      assert(
+        logInfoSpy.calledWith(
+          sinon.match(
+            /Loaded module 'prettier@2.0.2' from '.*[\/\\]eslint[\/\\]node_modules[\/\\]prettier[\/\\]index.js'/
+          )
+        )
+      );
+    });
+
+    test("it returns prettier version from module dep", () => {
+      const fileName = path.join(
+        getWorkspaceFolderUri("module").fsPath,
+        "index.js"
+      );
+      const prettierInstance = moduleResolver.getPrettierInstance(fileName);
+
+      assert.notEqual(prettierInstance, prettier);
+      assert.equal(prettierInstance.version, "2.0.2");
+      assert(
+        logInfoSpy.calledWith(
+          sinon.match(
+            /Loaded module 'prettier@2\.0\.2' from '.*[\/\\]module[\/\\]node_modules[\/\\]prettier[\/\\]index\.js'/
+          )
+        )
+      );
+    });
+  });
+});

src/test/suite/format.test.ts

@@ -17,7 +17,7 @@ const readFileAsync: (
  * gets the workspace folder by name
  * @param name Workspace folder name
  */
-const getWorkspaceFolderUri = (workspaceFolderName: string) => {
+export const getWorkspaceFolderUri = (workspaceFolderName: string) => {
   const workspaceFolder = vscode.workspace.workspaceFolders!.find((folder) => {
     return folder.name === workspaceFolderName;
   });

src/test/suite/module.test.ts

@@ -4,6 +4,12 @@ import { format, getText } from "./format.test";
 suite("Test module resolution", function () {
   this.timeout(10000);
 
+  test("it formats without prettier dep using internal version", async () => {
+    const { actual } = await format("no-dep", "index.js");
+    const expected = await getText("no-dep", "index.result.js");
+    assert.equal(actual, expected);
+  });
+
   test("it formats without prettier in package.json", async () => {
     const { actual } = await format("module", "index.js");
     const expected = await getText("module", "index.result.js");

test-fixtures/no-dep/.prettierrc

@@ -0,0 +1,3 @@
+{
+  "tabWidth": 2
+}

test-fixtures/no-dep/index.js

@@ -0,0 +1,7 @@
+function ugly(a    ,    b ,c){
+
+
+    return    a + 
+
+    b;
+}

test-fixtures/no-dep/index.result.js

@@ -0,0 +1,3 @@
+function ugly(a, b, c) {
+  return a + b;
+}

test-fixtures/no-dep/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "test-no-dep",
+  "version": "1.0.0",
+  "description": "Test folder for no prettier dependency",
+  "private": true,
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "jhilker",
+  "license": "MIT"
+}

test-fixtures/test.code-workspace

@@ -26,6 +26,9 @@
     },
     {
       "path": "module-plugin"
+    },
+    {
+      "path": "no-dep"
     }
   ],
   "settings": {
@@ -86,4 +89,4 @@
     },
     "prettier.trailingComma": "all"
   }
-}
+}