Switched tsconfig.json back to module: commonjs (#1399)

* Switched tsconfig.json back to module: commonjs

* Split up tsconfig.json to revert built code to commonjs

* Made tests reference source

* Remove module option from tsconfig.base.json

* Rename tsc to compile in config.yml

* tsconfig.eslint.json

Author: JoshuaKGoldberg

.circleci/config.yml

@@ -29,7 +29,7 @@ jobs:
                       - package-lock.json
                       - src
 
-    eslint:
+    compile:
         docker:
             - image: circleci/node:latest
 
@@ -41,9 +41,14 @@ jobs:
             - attach_workspace:
                   at: "."
 
-            - run: npm run eslint
+            - run: npm run compile
 
-    publish:
+            - persist_to_workspace:
+                  root: "."
+                  paths:
+                      - src
+
+    eslint:
         docker:
             - image: circleci/node:latest
 
@@ -55,11 +60,9 @@ jobs:
             - attach_workspace:
                   at: "."
 
-            - run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > .npmrc
-
-            - run: npm publish || exit 0
+            - run: npm run eslint
 
-    prettier:
+    publish:
         docker:
             - image: circleci/node:latest
 
@@ -71,9 +74,11 @@ jobs:
             - attach_workspace:
                   at: "."
 
-            - run: npm run prettier --check
+            - run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > .npmrc
 
-    test:
+            - run: npm publish || exit 0
+
+    prettier:
         docker:
             - image: circleci/node:latest
 
@@ -85,9 +90,9 @@ jobs:
             - attach_workspace:
                   at: "."
 
-            - run: npm run test:ci
+            - run: npm run prettier --check
 
-    tsc:
+    test:
         docker:
             - image: circleci/node:latest
 
@@ -99,12 +104,7 @@ jobs:
             - attach_workspace:
                   at: "."
 
-            - run: npm run tsc
-
-            - persist_to_workspace:
-                  root: "."
-                  paths:
-                      - src
+            - run: npm run test:ci
 
 workflows:
     version: 2
@@ -119,13 +119,13 @@ workflows:
                       branches:
                           only: main
                   requires:
-                      - tsc
+                      - compile
             - prettier:
                   requires:
                       - build
             - test:
                   requires:
                       - build
-            - tsc:
+            - compile:
                   requires:
                       - build

.eslintrc.cjs

@@ -14,7 +14,7 @@ module.exports = {
     ],
     parser: "@typescript-eslint/parser",
     parserOptions: {
-        project: "tsconfig.json",
+        project: "tsconfig.eslint.json",
     },
     plugins: ["simple-import-sort", "@typescript-eslint"],
     rules: {

package.json

@@ -61,14 +61,14 @@
         "url": "github:typescript-eslint/tslint-to-eslint-config"
     },
     "scripts": {
+        "compile": "tsc -b",
         "eslint": "eslint \"./src/*.ts\" \"./src/**/*.ts\" --report-unused-disable-directives",
         "precommit": "lint-staged",
         "prepare": "husky install",
         "prettier": "prettier \"./src/*.{js,json,ts,xml,yaml}\" \"./src/**/*.{js,json,ts,xml,yaml}\" --ignore-path .prettierignore",
         "prettier:write": "npm run prettier -- --write",
         "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest",
-        "test:ci": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --coverage --maxWorkers=2",
-        "tsc": "tsc"
+        "test:ci": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --coverage --maxWorkers=2"
     },
     "type": "module",
     "version": "3.0.0-alpha.0"

src/cli/runCli.test.ts

@@ -1,5 +1,7 @@
-import { describe, expect, it } from "@jest/globals";
+import { describe, expect, it, jest } from "@jest/globals";
+import path from "node:path";
 import { EOL } from "os";
+import { fileURLToPath } from "url";
 
 import { createStubLogger, expectEqualWrites } from "../adapters/logger.stubs";
 import { createStubOriginalConfigurationsData } from "../settings.stubs";
@@ -19,14 +21,23 @@ const createStubRunCliDependencies = (overrides: Partial<RunCliDependencies> = {
     logger: createStubLogger(),
 });
 
+Object.defineProperty(global, "__dirname", {
+    value: path.join(fileURLToPath(import.meta.url), ".."),
+    writable: true,
+});
+
+jest.mock("fs", () => ({
+    promises: {
+        readFile: async () => JSON.stringify(jest.requireActual("../../package.json")),
+    },
+}));
+
 describe("runCli", () => {
     it("prints the package version when --version is provided", async () => {
         // Arrange
         const rawArgv = createStubArgv(["--version"]);
         const dependencies = createStubRunCliDependencies();
-        const {
-            default: { version },
-        } = await import("../../package.json");
+        const { version } = jest.requireActual("../../package.json") as { version: string };
 
         // Act
         await runCli(dependencies, rawArgv);

src/cli/runCli.ts

@@ -3,10 +3,6 @@ import { Command } from "commander";
 import { promises as fs } from "fs";
 import { EOL } from "node:os";
 import path from "node:path";
-import { fileURLToPath } from "node:url";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
 
 import { Logger } from "../adapters/logger";
 import { SansDependencies } from "../binding";

tsconfig.base.json

@@ -0,0 +1,24 @@
+{
+    "compilerOptions": {
+        "alwaysStrict": true,
+        "declaration": true,
+        "esModuleInterop": true,
+        "incremental": true,
+        "lib": [],
+        "moduleResolution": "node",
+        "noFallthroughCasesInSwitch": true,
+        "noImplicitAny": true,
+        "noImplicitReturns": true,
+        "noImplicitThis": true,
+        "noUnusedLocals": true,
+        "noUnusedParameters": true,
+        "resolveJsonModule": true,
+        "sourceMap": true,
+        "strict": true,
+        "strictBindCallApply": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "strictPropertyInitialization": true,
+        "target": "es2018"
+    }
+}

tsconfig.eslint.json

@@ -0,0 +1,4 @@
+{
+    "extends": "./tsconfig.base.json",
+    "include": ["src"]
+}

tsconfig.json

@@ -1,27 +1,7 @@
 {
     "compilerOptions": {
-        "alwaysStrict": true,
-        "declaration": true,
-        "esModuleInterop": true,
-        "incremental": true,
-        "lib": [],
-        "module": "esnext",
-        "moduleResolution": "node",
-        "noFallthroughCasesInSwitch": true,
-        "noImplicitAny": true,
-        "noImplicitReturns": true,
-        "noImplicitThis": true,
-        "noUnusedLocals": true,
-        "noUnusedParameters": true,
-        "resolveJsonModule": true,
-        "sourceMap": true,
-        "strict": true,
-        "strictBindCallApply": true,
-        "strictFunctionTypes": true,
-        "strictNullChecks": true,
-        "strictPropertyInitialization": true,
-        "target": "es2018"
+        "composite": true
     },
-    "exclude": ["test/tests/**/*"],
-    "include": ["src/**/*"]
+    "files": [],
+    "references": [{ "path": "./tsconfig.source.json" }, { "path": "./tsconfig.test.json" }]
 }

tsconfig.source.json

@@ -0,0 +1,9 @@
+{
+    "compilerOptions": {
+        "composite": true,
+        "module": "commonjs"
+    },
+    "exclude": ["**/*.test.*"],
+    "extends": "./tsconfig.base.json",
+    "include": ["src"]
+}

tsconfig.test.json

@@ -0,0 +1,10 @@
+{
+    "compilerOptions": {
+        "composite": true,
+        "module": "esnext",
+        "noEmit": true
+    },
+    "extends": "./tsconfig.base.json",
+    "include": ["**/*.test.*"],
+    "references": [{ "path": "./tsconfig.source.json" }]
+}