refactor: separate tests into own module (#371)

ojeytonwilliams · web-flow · commit cded6b07e444 · 2025-07-01T17:36:26.000+02:00
* refactor: separate tests into own module

I've also tried to keep the numbers of imported types down so there's
less chance of duplicate declarations.

Finally, the Enzyme types seem a little broken, so I declared them. We
only use a single method, so it seems fine for now.

* fix: use node 22's types
diff --git a/base-tsconfig.json b/base-tsconfig.json
@@ -10,7 +10,7 @@
     "skipLibCheck": true,
     "sourceMap": true,
     "strict": true,
-    "target": "ES2024",
-    "types": ["vitest/globals"]
+    "types": [],
+    "target": "ES2024"
   }
 }
diff --git a/package.json b/package.json
@@ -103,9 +103,9 @@
   "license": "BSD-3-Clause",
   "dependencies": {
     "@sinonjs/fake-timers": "^14.0.0",
-    "@types/enzyme": "^3.10.19",
-    "@types/enzyme-adapter-react-16": "^1.0.9",
     "@types/jquery": "^3.5.32",
+    "@types/react": "^19.1.8",
+    "@types/react-dom": "^19.1.6",
     "@types/sinonjs__fake-timers": "^8.1.5",
     "browserify": "^17.0.0",
     "chai": "4",
diff --git a/packages/dom-evaluator/src/declarations.ts b/packages/dom-evaluator/src/declarations.ts
@@ -0,0 +1,15 @@
+declare module "enzyme" {
+  interface ConfigureOptions {
+    adapter: object;
+  }
+
+  export function configure(options: ConfigureOptions): void;
+}
+
+declare module "enzyme-adapter-react-16" {
+  class Adapter {
+    constructor();
+  }
+
+  export default Adapter;
+}
diff --git a/packages/dom-evaluator/src/dom-test-evaluator.ts b/packages/dom-evaluator/src/dom-test-evaluator.ts
@@ -27,15 +27,12 @@ const READY_MESSAGE: ReadyEvent["data"] = { type: "ready" };
 
 declare global {
   var __FakeTimers: typeof FakeTimers;
-  // @ts-expect-error chai is not accessible in the global scope
   var assert: typeof chaiAssert;
 }
 
 // @ts-expect-error jQuery cannot be declared.
 globalThis.$ = jQuery;
-// @ts-expect-error somehow importing Enzyme makes TS think you cannot modify globalThis
 globalThis.__FakeTimers = FakeTimers;
-// @ts-expect-error somehow importing Enzyme makes TS think you cannot modify globalThis
 globalThis.assert = chaiAssert;
 
 // Local storage is not accessible in a sandboxed iframe, so we need to mock it
diff --git a/packages/helpers/tsconfig.json b/packages/helpers/tsconfig.json
@@ -1,6 +1,5 @@
 {
   "extends": "../../base-tsconfig.json",
-  "exclude": ["**/__tests__", "**/__fixtures__", "**/__mocks__"],
   "compilerOptions": {
     "rootDir": "./",
     "declarationDir": "../../dist/types/helpers",
diff --git a/packages/javascript-evaluator/src/javascript-test-evaluator.ts b/packages/javascript-evaluator/src/javascript-test-evaluator.ts
@@ -17,7 +17,6 @@ import { ProxyConsole, createLogFlusher } from "../../shared/src/proxy-console";
 
 const READY_MESSAGE: ReadyEvent["data"] = { type: "ready" };
 declare global {
-  // @ts-expect-error chai is not accessible in the global scope, but TS thinks it is
   var assert: typeof chaiAssert;
   var __helpers: typeof curriculumHelpers;
 }
diff --git a/packages/shared/package.json b/packages/shared/package.json
@@ -0,0 +1,17 @@
+{
+  "name": "@freecodecamp/shared",
+  "description": "Shared modules.",
+  "private": true,
+  "engines": {
+    "pnpm": ">= 10"
+  },
+  "scripts": {},
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/freeCodeCamp/curriculum-helpers.git"
+  },
+  "license": "BSD-3-Clause",
+  "dependencies": {
+    "@types/node": "^22.15.34"
+  }
+}
diff --git a/packages/shared/tsconfig.json b/packages/shared/tsconfig.json
@@ -3,6 +3,7 @@
   "compilerOptions": {
     "lib": ["DOM", "ESNext"],
     "rootDir": "./",
+    "types": ["node"],
     "declarationDir": "../../dist/types/shared",
     "outDir": "./build",
     "tsBuildInfoFile": ".tsbuildinfo"
diff --git a/packages/tests/__fixtures__/curriculum-helper-css.ts b/packages/tests/__fixtures__/curriculum-helper-css.ts
diff --git a/packages/tests/__fixtures__/curriculum-helpers-html.ts b/packages/tests/__fixtures__/curriculum-helpers-html.ts
diff --git a/packages/tests/__fixtures__/curriculum-helpers-javascript.ts b/packages/tests/__fixtures__/curriculum-helpers-javascript.ts
diff --git a/packages/tests/__fixtures__/curriculum-helpers-remove-white-space.ts b/packages/tests/__fixtures__/curriculum-helpers-remove-white-space.ts
diff --git a/packages/tests/awaitable-post.test.ts b/packages/tests/awaitable-post.test.ts
@@ -1,4 +1,4 @@
-import { post } from "./awaitable-post";
+import { post } from "../main/src/awaitable-post";
 
 // Echos the post data back
 class MockWorker {
diff --git a/packages/tests/css-helper.test.ts b/packages/tests/css-helper.test.ts
@@ -1,6 +1,6 @@
 // @vitest-environment jsdom
-import { cssString } from "../__fixtures__/curriculum-helper-css";
-import { CSSHelp } from "../index";
+import { cssString } from "./__fixtures__/curriculum-helper-css";
+import { CSSHelp } from "./../helpers/lib/index";
 
 describe("css-help", () => {
   const doc = document;
@@ -15,7 +15,10 @@ describe("css-help", () => {
     // REF: https://github.com/freeCodeCamp/freeCodeCamp/pull/42148#issuecomment-847291137
     const mediaRule = t.getCSSRules("media")?.[0] as CSSMediaRule;
     const conditionText = mediaRule.media[0];
-    mediaRule.conditionText = conditionText;
+    Object.defineProperty(mediaRule, "conditionText", {
+      value: conditionText,
+      configurable: true,
+    });
   });
   describe("getStyle", () => {
     it("should return an ExtendedCSSStyleDeclartion object of length 1", () => {
diff --git a/packages/tests/curriculum-helper.test.tsx b/packages/tests/curriculum-helper.test.tsx
@@ -3,11 +3,11 @@
 import React from "react";
 import ReactDOM from "react-dom/client";
 
-import cssTestValues from "../__fixtures__/curriculum-helper-css";
-import htmlTestValues from "../__fixtures__/curriculum-helpers-html";
-import jsTestValues from "../__fixtures__/curriculum-helpers-javascript";
-import whiteSpaceTestValues from "../__fixtures__/curriculum-helpers-remove-white-space";
-import * as helper from "../index";
+import cssTestValues from "./__fixtures__/curriculum-helper-css";
+import htmlTestValues from "./__fixtures__/curriculum-helpers-html";
+import jsTestValues from "./__fixtures__/curriculum-helpers-javascript";
+import whiteSpaceTestValues from "./__fixtures__/curriculum-helpers-remove-white-space";
+import * as helper from "./../helpers/lib/index";
 
 const { stringWithWhiteSpaceChars, stringWithWhiteSpaceCharsRemoved } =
   whiteSpaceTestValues;
diff --git a/packages/tests/dom-test-evaluator.test.ts b/packages/tests/dom-test-evaluator.test.ts
@@ -1,6 +1,6 @@
 /* @jest-environment jsdom */
 
-import { DOMTestEvaluator } from "./dom-test-evaluator";
+import { DOMTestEvaluator } from "../dom-evaluator/src/dom-test-evaluator";
 
 // This is a limited reset, but should be enough if we only add or remove
 // elements.
diff --git a/packages/tests/format.test.ts b/packages/tests/format.test.ts
@@ -1,5 +1,5 @@
 // @vitest-environment jsdom
-import { format } from "./format";
+import { format } from "../shared/src/format";
 
 function simpleFun() {
   // eslint-disable-next-line no-var, @typescript-eslint/no-unused-vars
diff --git a/packages/tests/integration-tests/declarations.d.ts b/packages/tests/integration-tests/declarations.d.ts
diff --git a/packages/tests/integration-tests/index.test.ts b/packages/tests/integration-tests/index.test.ts
@@ -1,5 +1,13 @@
 import "vitest-environment-puppeteer";
 import { compileForTests } from "../../shared/tooling/webpack-compile";
+import type { FCCTestRunner } from "../../main/src/index";
+import { Fail, Pass } from "../../shared/src/interfaces/test-evaluator";
+
+declare global {
+  interface Window {
+    FCCTestRunner: FCCTestRunner;
+  }
+}
 
 describe("Test Runner", () => {
   beforeAll(async () => {
@@ -147,7 +155,7 @@ describe("Test Runner", () => {
             type,
           });
 
-          const logs = [];
+          const logs: (Pass | Fail)[] = [];
 
           for (const level of levels) {
             logs.push(
diff --git a/packages/tests/integration-tests/timeout.test.ts b/packages/tests/integration-tests/timeout.test.ts
diff --git a/packages/tests/javascript-helper.test.ts b/packages/tests/javascript-helper.test.ts
@@ -1,6 +1,6 @@
-import jsTestValues from "../__fixtures__/curriculum-helpers-javascript";
+import jsTestValues from "./__fixtures__/curriculum-helpers-javascript";
 
-import { getFunctionParams } from "../index";
+import { getFunctionParams } from "./../helpers/lib/index";
 
 const {
   functionDeclaration,
@@ -12,32 +12,32 @@ const {
 
 describe("js-help", () => {
   describe("getFunctionArgs", () => {
-    it("gets arguments from function declarations", function () {
+    it("gets arguments from function declarations", () => {
       const parameters = getFunctionParams(functionDeclaration);
       expect(parameters[0].name).toBe("param1");
       expect(parameters[1].defaultValue).toBe("default");
       expect(parameters[1].name).toBe("param2");
       expect(parameters[2].name).toBe("param3");
     });
-    it("gets arguments from const function variables", function () {
+    it("gets arguments from const function variables", () => {
       const parameters = getFunctionParams(constFunction);
       expect(parameters[0].name).toBe("param1");
       expect(parameters[1].defaultValue).toBe("default");
       expect(parameters[1].name).toBe("param2");
       expect(parameters[2].name).toBe("param3");
     });
-    it("gets arguments from let function variables", function () {
+    it("gets arguments from let function variables", () => {
       const parameters = getFunctionParams(letFunction);
       expect(parameters[0].name).toBe("param1");
       expect(parameters[1].defaultValue).toBe("default");
       expect(parameters[1].name).toBe("param2");
       expect(parameters[2].name).toBe("param3");
     });
-    it("gets arguments from arrow functions", function () {
+    it("gets arguments from arrow functions", () => {
       const parameters = getFunctionParams(arrowFunction);
       expect(parameters[0].name).toBe("name");
     });
-    it("gets arguments from a destructured function declaration", function () {
+    it("gets arguments from a destructured function declaration", () => {
       const parameters = getFunctionParams(destructuredArgsFunctionDeclaration);
       expect(parameters[0].name).toBe("a");
       expect(parameters[1].name).toBe("b");
diff --git a/packages/tests/javascript-test-evaluator.test.ts b/packages/tests/javascript-test-evaluator.test.ts
@@ -1,6 +1,6 @@
 /* @jest-environment jsdom */
 
-import { JavascriptTestEvaluator } from "./javascript-test-evaluator";
+import { JavascriptTestEvaluator } from "../javascript-evaluator/src/javascript-test-evaluator";
 
 describe("JavascriptTestEvaluator", () => {
   let evaluator: JavascriptTestEvaluator;
diff --git a/packages/tests/mock-local-storage.test.ts b/packages/tests/mock-local-storage.test.ts
@@ -1,4 +1,4 @@
-import { MockLocalStorage } from "./mock-local-storage";
+import { MockLocalStorage } from "../dom-evaluator/src/mock-local-storage";
 
 describe("MockLocalStorage", () => {
   describe("length", () => {
diff --git a/packages/tests/proxy-console.test.ts b/packages/tests/proxy-console.test.ts
@@ -1,6 +1,6 @@
 // @vitest-environment jsdom
 
-import { ProxyConsole } from "./proxy-console";
+import { ProxyConsole } from "../shared/src/proxy-console";
 
 const LEVELS = ["trace", "debug", "info", "log", "warn", "error"] as const;
 
diff --git a/packages/tests/python.test.ts b/packages/tests/python.test.ts
@@ -1,5 +1,5 @@
 /* eslint-disable camelcase */
-import * as helper from "../index";
+import * as helper from "./../helpers/lib/index";
 
 type FunctionMatch = {
   def: string;
@@ -43,7 +43,7 @@ def c():
     it("handles indentation", () => {
       const code = `
     a = 1
-      
+
     def b(d, e):
       a = 2
     `;
@@ -211,7 +211,7 @@ def vigenere(message, key):
 `;
 
       const commentless_code = python.removeComments(el);
-      const { block_body } = python.getBlock(commentless_code, "else")!;
+      const { block_body } = python.getBlock(commentless_code, "else");
       expect(block_body).toEqual(
         "\n            key_char = key[key_index % len(key)]",
       );
diff --git a/packages/tests/tsconfig.json b/packages/tests/tsconfig.json
@@ -0,0 +1,23 @@
+{
+  "extends": "../../base-tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./",
+    "lib": ["dom", "ESNext"],
+    "types": ["vitest/globals", "react"],
+    "jsx": "preserve",
+    "strict": false,
+    "noEmit": true,
+    "tsBuildInfoFile": ".tsbuildinfo"
+  },
+  "references": [
+    {
+      "path": "../dom-evaluator"
+    },
+    {
+      "path": "../javascript-evaluator"
+    },
+    {
+      "path": "../main"
+    }
+  ]
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/tsconfig.json b/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`"skipLibCheck": true,`
`11`	`11`	`"sourceMap": true,`
`12`	`12`	`"strict": true,`
`13`		`- "target": "ES2024",`
`14`		`- "types": ["vitest/globals"]`
	`13`	`+ "types": [],`
	`14`	`+ "target": "ES2024"`
`15`	`15`	`}`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"extends": "../../base-tsconfig.json",`
`3`		`- "exclude": ["/__tests__", "/__fixtures__", "**/__mocks__"],`
`4`	`3`	`"compilerOptions": {`
`5`	`4`	`"rootDir": "./",`
`6`	`5`	`"declarationDir": "../../dist/types/helpers",`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,6 @@ import { ProxyConsole, createLogFlusher } from "../../shared/src/proxy-console";`
`17`	`17`
`18`	`18`	`const READY_MESSAGE: ReadyEvent["data"] = { type: "ready" };`
`19`	`19`	`declare global {`
`20`		`- // @ts-expect-error chai is not accessible in the global scope, but TS thinks it is`
`21`	`20`	`var assert: typeof chaiAssert;`
`22`	`21`	`var __helpers: typeof curriculumHelpers;`
`23`	`22`	`}`