Update: pass cwd to formatters (refs eslint/rfcs#57)

eslint · Jun 5, 2020 · 43a7e20 · 43a7e20
1 parent dd949ae
commit 43a7e20
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 5 deletions.
diff --git a/lib/eslint/eslint.js b/lib/eslint/eslint.js
@@ -575,7 +575,7 @@ class ESLint {
             throw new Error("'name' must be a string");
         }
 
-        const { cliEngine } = privateMembersMap.get(this);
+        const { cliEngine, options } = privateMembersMap.get(this);
         const formatter = cliEngine.getFormatter(name);
 
         if (typeof formatter !== "function") {
@@ -595,6 +595,9 @@ class ESLint {
                 results.sort(compareResultsByFilePath);
 
                 return formatter(results, {
+                    get cwd() {
+                        return options.cwd;
+                    },
                     get rulesMeta() {
                         if (!rulesMeta) {
                             rulesMeta = createRulesMeta(cliEngine.getRules());

diff --git a/tests/_utils/in-memory-fs.js b/tests/_utils/in-memory-fs.js
@@ -392,6 +392,7 @@ function defineCascadingConfigArrayFactoryWithInMemoryFileSystem({
     // Override the default cwd.
     return {
         fs,
+        stubs,
         RelativeModuleResolver,
         ConfigArrayFactory,
         CascadingConfigArrayFactory: cwd === process.cwd
@@ -417,6 +418,7 @@ function defineFileEnumeratorWithInMemoryFileSystem({
 } = {}) {
     const {
         fs,
+        stubs,
         RelativeModuleResolver,
         ConfigArrayFactory,
         CascadingConfigArrayFactory
@@ -430,6 +432,7 @@ function defineFileEnumeratorWithInMemoryFileSystem({
     // Override the default cwd.
     return {
         fs,
+        stubs,
         RelativeModuleResolver,
         ConfigArrayFactory,
         CascadingConfigArrayFactory,
@@ -456,13 +459,15 @@ function defineCLIEngineWithInMemoryFileSystem({
 } = {}) {
     const {
         fs,
+        stubs,
         RelativeModuleResolver,
         ConfigArrayFactory,
         CascadingConfigArrayFactory,
         FileEnumerator
     } =
         defineFileEnumeratorWithInMemoryFileSystem({ cwd, files });
     const { CLIEngine, getCLIEngineInternalSlots } = proxyquire(CLIEnginePath, {
+        ...stubs,
         fs,
         "./cascading-config-array-factory": { CascadingConfigArrayFactory },
         "./file-enumerator": { FileEnumerator },

diff --git a/tests/lib/cli.js b/tests/lib/cli.js
@@ -241,10 +241,13 @@ describe("cli", () => {
 
             // Check metadata.
             const { metadata } = JSON.parse(log.info.args[0][0]);
-            const expectedMetadata = Array.from(BuiltinRules).reduce((obj, [ruleId, rule]) => {
-                obj.rulesMeta[ruleId] = rule.meta;
-                return obj;
-            }, { rulesMeta: {} });
+            const expectedMetadata = {
+                cwd: process.cwd(),
+                rulesMeta: Array.from(BuiltinRules).reduce((obj, [ruleId, rule]) => {
+                    obj[ruleId] = rule.meta;
+                    return obj;
+                }, {})
+            };
 
             assert.deepStrictEqual(metadata, expectedMetadata);
         });

diff --git a/tests/lib/eslint/eslint.js b/tests/lib/eslint/eslint.js
@@ -4318,6 +4318,23 @@ describe("ESLint", () => {
                 await engine.loadFormatter(5);
             }, /'name' must be a string/u);
         });
+
+        it("should pass cwd to the `cwd` property of the second argument.", async () => {
+            const ESLintWithInMemoryFs = defineESLintWithInMemoryFileSystem({
+                cwd: () => __dirname,
+                files: {
+                    "node_modules/eslint-formatter-return-cwd/index.js": "module.exports = (results, context) => context.cwd;",
+                    "test.js": "",
+                    ".eslintrc.json": "{}"
+                }
+            }).ESLint;
+            const cwd = path.join(__dirname, "foo/bar");
+            const eslint = new ESLintWithInMemoryFs({ cwd });
+            const formatter = await eslint.loadFormatter("return-cwd");
+
+            // This formatter just returns cwd.
+            assert.strictEqual(formatter.format([]), cwd);
+        });
     });
 
     describe("getErrorResults()", () => {