Add tests for the ESLint caching. (vercel#2859)

I pulled the trigger too fast on vercel#2850, these are the tests that should have been written for it.

.eslintignore

@@ -6,6 +6,7 @@ dist/
 
 /examples/
 
+packages/eslint-plugin-turbo/__tests__/fixtures
 packages/create-turbo/templates
 packages/turbo-tracing-next-plugin/test/with-mongodb-mongoose
 crates/*/tests/**

package.json

@@ -11,7 +11,7 @@
     "format:prettier": "prettier -w .",
     "format:rs": "cargo fmt --all",
     "format:toml": "taplo format",
-    "lint": "eslint . --ext js,jsx,ts,tsx -c ./.eslintrc.js",
+    "lint": "eslint . --ext js,jsx,ts,tsx",
     "turbo": "cd cli && make turbo && cd .. && node turbow.js",
     "docs": "pnpm -- turbo run dev --filter=docs --no-cache",
     "run-example": "./scripts/run-example.sh"
@@ -33,10 +33,11 @@
     "typescript": "^4.8.4"
   },
   "lint-staged": {
-    "*.@(js|ts)": [
-      "eslint --quiet --fix"
+    "*.{js,jsx,ts,tsx}": [
+      "pnpm run lint --quiet --fix --",
+      "prettier --write"
     ],
-    "*.{ts,tsx,md,mdx,js,jsx,mjs,yml,yaml,css}": [
+    "*.{md,mdx,mjs,yml,yaml,css}": [
       "prettier --write"
     ],
     "*.go": [

packages/eslint-plugin-turbo/__tests__/cwd.test.ts

@@ -0,0 +1,111 @@
+import fs from "fs";
+import path from "path";
+import JSON5 from "json5";
+import { execSync } from "child_process";
+
+describe("eslint settings check", () => {
+  beforeAll(() => {
+    const cwd = path.join(__dirname, "fixtures", "workspace");
+    execSync(`npm install`, { cwd });
+  });
+
+  afterAll(() => {
+    const nodeModulesDir = path.join(
+      __dirname,
+      "fixtures",
+      "workspace",
+      "node_modules"
+    );
+    fs.rmSync(nodeModulesDir, { force: true, recursive: true });
+  });
+
+  it("does the right thing for peers", () => {
+    const cwd = path.join(__dirname, "fixtures", "workspace");
+    const configString = execSync(`eslint --print-config peer.js`, {
+      cwd,
+      encoding: "utf8",
+    });
+    const configJson = JSON.parse(configString);
+
+    expect(configJson.settings).toEqual({
+      turbo: { envVars: ["CI", "UNORDERED"] },
+    });
+  });
+
+  it("does the right thing for child dirs", () => {
+    const cwd = path.join(__dirname, "fixtures", "workspace", "child");
+    const configString = execSync(`eslint --print-config child.js`, {
+      cwd,
+      encoding: "utf8",
+    });
+    const configJson = JSON.parse(configString);
+
+    expect(configJson.settings).toEqual({
+      turbo: { envVars: ["CI", "UNORDERED"] },
+    });
+  });
+});
+
+describe("eslint cache is busted", () => {
+  let turboJsonPath: string;
+  let originalString: string;
+
+  beforeAll(() => {
+    const cwd = path.join(__dirname, "fixtures", "workspace");
+    execSync(`npm install`, { cwd });
+
+    turboJsonPath = path.join(__dirname, "fixtures", "workspace", "turbo.json");
+    originalString = fs.readFileSync(turboJsonPath, { encoding: "utf8" });
+  });
+
+  afterEach(() => {
+    fs.writeFileSync(turboJsonPath, originalString);
+  });
+
+  afterAll(() => {
+    fs.writeFileSync(turboJsonPath, originalString);
+
+    const nodeModulesDir = path.join(
+      __dirname,
+      "fixtures",
+      "workspace",
+      "node_modules"
+    );
+    fs.rmSync(nodeModulesDir, { force: true, recursive: true });
+  });
+
+  it("catches a lint error after changing config", () => {
+    expect.assertions(2);
+
+    // ensure that we populate the cache with a failure.
+    const cwd = path.join(__dirname, "fixtures", "workspace", "child");
+    try {
+      execSync(`eslint --format=json child.js`, { cwd, encoding: "utf8" });
+    } catch (error: any) {
+      const outputJson = JSON.parse(error.stdout);
+      expect(outputJson).toMatchObject([
+        {
+          messages: [
+            {
+              message:
+                "$NONEXISTENT is not listed as a dependency in turbo.json",
+            },
+          ],
+        },
+      ]);
+    }
+
+    // change the configuration
+    const turboJson = JSON5.parse(originalString);
+    turboJson.globalEnv = ["CI", "NONEXISTENT"];
+    fs.writeFileSync(turboJsonPath, JSON.stringify(turboJson, null, 2));
+
+    // test that we invalidated the eslint cache
+    const output = execSync(`eslint --format=json child.js`, {
+      cwd,
+      encoding: "utf8",
+    });
+    const outputJson = JSON.parse(output);
+    expect(outputJson).toMatchObject([{ errorCount: 0 }]);
+  });
+});

packages/eslint-plugin-turbo/__tests__/fixtures/workspace/.eslintrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  root: true,
+  extends: ["plugin:turbo/recommended"],
+};

packages/eslint-plugin-turbo/__tests__/fixtures/workspace/child/child.js

@@ -0,0 +1,2 @@
+process.env.NONEXISTENT
+process.env.CI

packages/eslint-plugin-turbo/__tests__/fixtures/workspace/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "eslint-plugin-turbo": "../../.."
+  }
+}

packages/eslint-plugin-turbo/__tests__/fixtures/workspace/peer.js

@@ -0,0 +1 @@
+process.env.CI

packages/eslint-plugin-turbo/__tests__/lib/fixtures/workspace/turbo.json → packages/eslint-plugin-turbo/__tests__/fixtures/workspace/turbo.json

@@ -1,5 +1,6 @@
 {
   "$schema": "https://turbo.build/schema.json",
+  "globalEnv": ["UNORDERED", "CI"],
   "pipeline": {
     "build": {
       // A workspace's `build` task depends on that workspace's

packages/eslint-plugin-turbo/__tests__/lib/findTurboConfig.test.ts

@@ -3,9 +3,10 @@ import findTurboConfig from "../../lib/utils/findTurboConfig";
 
 describe("findTurboConfig", () => {
   it("it parses valid turbo.json file", () => {
-    const cwd = path.resolve(__dirname, "./fixtures/workspace");
+    const cwd = path.join(__dirname, "..", "fixtures", "workspace");
     expect(findTurboConfig({ cwd })).toEqual({
       $schema: "https://turbo.build/schema.json",
+      globalEnv: ["UNORDERED", "CI"],
       pipeline: {
         build: {
           dependsOn: ["^build"],

packages/eslint-plugin-turbo/jest.config.js

@@ -4,6 +4,7 @@ module.exports = {
   transform: {
     "^.+\\.tsx?$": "ts-jest",
   },
+  testPathIgnorePatterns: [".+/fixtures/.+"],
   moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
   modulePathIgnorePatterns: ["<rootDir>/node_modules", "<rootDir>/dist"],
   preset: "ts-jest",

packages/eslint-plugin-turbo/lib/configs/recommended.ts

@@ -7,7 +7,7 @@ const envVars = getEnvVarDependencies({
 });
 const settings = {
   turbo: {
-    envVars: envVars ? [...envVars] : [],
+    envVars: envVars ? [...envVars].sort() : [],
   },
 };
 

turbo.json

@@ -1,6 +1,9 @@
 {
   "$schema": "./docs/public/schema.json",
   "pipeline": {
+    "eslint-plugin-turbo#test": {
+      "dependsOn": ["build"]
+    },
     "test": {
       "outputs": ["coverage/**/*"],
       "dependsOn": ["^build"]