feat: Added NX Transformer

nonara · nonara · commit 66191641bcd0 · 2022-10-20T16:36:31.000-04:00
diff --git a/README.md b/README.md
@@ -51,10 +51,10 @@ import { sum } from "@utils/sum";
 
 ### 3. Usage
 
-- **To compile with `tsc`** — Use [ts-patch](https://github.com/nonara/ts-patch)
+- **Compile with `tsc`** — Use [ts-patch](https://github.com/nonara/ts-patch)
 
 
-- **To use with ts-node** — Add `typescript-transform-paths/register` to `require` config.  
+- **Use with ts-node** — Add `typescript-transform-paths/register` to `require` config.  
    
     `tsconfig.json`
   ```jsonc
@@ -67,7 +67,30 @@ import { sum } from "@utils/sum";
   }
   ```
 
-- **To use with node** — Use the register script: `node -r typescript-transform-paths/register src/index.ts`
+- **Use with node** — Use the register script: `node -r typescript-transform-paths/register src/index.ts`
+
+- **Use with NX** — Add the `typescript-transform-paths/nx-transformer` to project config
+
+  `project.json`
+  ```jsonc
+  {
+    /* ... */
+    "targets": {
+      "build": {
+        /* ... */
+        "options": {
+          /* ... */
+          "transformers": [
+            { 
+              name": "typescript-transform-paths/nx-transformer",
+              "options": { "afterDeclarations": true }
+            }
+          ]
+        }
+      }
+    }
+  }
+  ```
 
 ## Virtual Directories
 TS allows defining
diff --git a/nx-transformer.js b/nx-transformer.js
@@ -0,0 +1,2 @@
+'use strict'
+module.exports = require('./').nxTransformerPlugin;
diff --git a/package.json b/package.json
@@ -11,12 +11,12 @@
     "release": "standard-version",
     "--------------": "",
     "format": "prettier --write \"{src,test}/**/{*.js,!(*.d).ts}\"",
-    "clean": "rimraf dist **/*.tsbuildinfo",
-    "clean:all": "yarn run clean && rimraf node_modules test/node_modules test/.yarn-cache",
+    "clean": "npx -y rimraf dist **/*.tsbuildinfo ./test/projects/nx/dist",
+    "clean:all": "yarn run clean && npx -y rimraf node_modules **/node_modules **/yarn.lock yarn.lock",
     "reset": "yarn run clean:all && yarn install",
     "-------------- ": "",
     "prebuild": "rimraf dist",
-    "install:tests": "cd test && yarn install && cd projects/extras && yarn install",
+    "install:tests": "cd test && yarn install",
     "prepare": "yarn run install:tests"
   },
   "keywords": [
@@ -48,7 +48,8 @@
     "types",
     "README.md",
     "CHANGELOG.md",
-    "register.js"
+    "register.js",
+    "nxTransformerPlugin.js"
   ],
   "devDependencies": {
     "@types/jest": "^29.2.0",
diff --git a/src/index.ts b/src/index.ts
@@ -3,3 +3,4 @@ export default transformer;
 
 export { TsTransformPathsConfig } from "./types";
 export { register } from "./register";
+export { nxTransformerPlugin } from "./plugins";
diff --git a/src/plugins/index.ts b/src/plugins/index.ts
@@ -0,0 +1 @@
+export * from "./nx-transformer-plugin";
diff --git a/src/plugins/nx-transformer-plugin.ts b/src/plugins/nx-transformer-plugin.ts
@@ -0,0 +1,20 @@
+import { NxTransformerPlugin } from "../../types";
+import transformer from "../transformer";
+import ts from "typescript";
+
+/* ****************************************************************************************************************** *
+ * Locals
+ * ****************************************************************************************************************** */
+
+const voidTransformer: ts.TransformerFactory<ts.SourceFile> = () => (s: ts.SourceFile) => s;
+
+/* ****************************************************************************************************************** *
+ * Transformer
+ * ****************************************************************************************************************** */
+
+export const nxTransformerPlugin: NxTransformerPlugin = {
+  before: (pluginConfig, program) =>
+    pluginConfig?.afterDeclarations ? voidTransformer : transformer(program, { ...pluginConfig }),
+  afterDeclarations: (pluginConfig, program) =>
+    !pluginConfig?.afterDeclarations ? voidTransformer : transformer(program, { ...pluginConfig }),
+};
diff --git a/test/package.json b/test/package.json
@@ -10,7 +10,13 @@
     "typescript-three": "npm:typescript@3.6.5",
     "typescript-four-seven": "npm:typescript@4.7.4",
     "typescript": "latest",
-    "ts-patch": "link:../node_modules/ts-patch"
+    "ts-patch": "link:../node_modules/ts-patch",
+    "ts-node": "link:../node_modues/ts-node",
+    "@nrwl/cli": "^15.0.0",
+    "@nrwl/js": "^15.0.0",
+    "@nrwl/node": "^15.0.0",
+    "@nrwl/workspace": "^15.0.0",
+    "nx": "^15.0.0"
   },
   "workspaces": [
     "projects/*"
diff --git a/test/projects/nx/nx.json b/test/projects/nx/nx.json
@@ -0,0 +1,19 @@
+{
+  "extends": "@nrwl/workspace/presets/core.json",
+  "npmScope": "nx",
+  "affected": {
+    "defaultBase": "main"
+  },
+  "cli": {
+    "defaultCollection": "@nrwl/workspace"
+  },
+  "tasksRunnerOptions": {
+    "default": {
+      "runner": "@nrwl/workspace/tasks-runners/default",
+      "options": {
+        "cacheableOperations": ["build", "lint", "test", "e2e"],
+        "useDaemonProcess": false
+      }
+    }
+  }
+}
diff --git a/test/projects/nx/package.json b/test/projects/nx/package.json
@@ -0,0 +1,12 @@
+{
+  "name": "nx",
+  "version": "0.0.0",
+  "scripts": {
+    "build": "yarn nx build library1 --skip-nx-cache"
+  },
+  "private": true,
+  "dependencies": {},
+  "devDependencies": {
+    "typescript-transform-paths": "link:../../../"
+  }
+}
diff --git a/test/projects/nx/packages/library1/package.json b/test/projects/nx/packages/library1/package.json
@@ -0,0 +1,4 @@
+{
+  "name": "library1",
+  "version": "0.0.1"
+}
diff --git a/test/projects/nx/packages/library1/project.json b/test/projects/nx/packages/library1/project.json
@@ -0,0 +1,31 @@
+{
+  "root": "packages/library1",
+  "sourceRoot": "packages/library1/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nrwl/node:webpack",
+      "outputs": [
+        "{options.outputPath}"
+      ],
+      "options": {
+        "outputPath": "dist/library1",
+        "main": "packages/library1/src/index.ts",
+        "outputFileName": "index.js",
+        "tsConfig": "packages/library1/tsconfig.lib.json",
+        "sourceMap": false,
+        "transformers": [
+          {
+            "name": "typescript-transform-paths/nx-transformer",
+            "options": {
+              "afterDeclarations": true
+            }
+          }
+        ]
+      },
+      "dependsOn": [
+      ]
+    }
+  },
+  "tags": [ ]
+}
diff --git a/test/projects/nx/packages/library1/src/index.ts b/test/projects/nx/packages/library1/src/index.ts
@@ -0,0 +1,4 @@
+import { name as library2Name } from "library2";
+export default library2Name;
+
+console.log(library2Name);
diff --git a/test/projects/nx/packages/library1/tsconfig.json b/test/projects/nx/packages/library1/tsconfig.json
@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    }
+  ]
+}
diff --git a/test/projects/nx/packages/library1/tsconfig.lib.json b/test/projects/nx/packages/library1/tsconfig.lib.json
@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "outDir": "../../dist/library1",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "include": ["src/*.ts"]
+}
diff --git a/test/projects/nx/packages/library2/package.json b/test/projects/nx/packages/library2/package.json
@@ -0,0 +1,4 @@
+{
+  "name": "library2",
+  "version": "0.0.1"
+}
diff --git a/test/projects/nx/packages/library2/project.json b/test/projects/nx/packages/library2/project.json
@@ -0,0 +1,8 @@
+{
+  "root": "packages/library2",
+  "sourceRoot": "packages/library2/src",
+  "projectType": "library",
+  "targets": {
+  },
+  "tags": []
+}
diff --git a/test/projects/nx/packages/library2/src/index.ts b/test/projects/nx/packages/library2/src/index.ts
@@ -0,0 +1 @@
+export const name = "library2";
diff --git a/test/projects/nx/packages/library2/tsconfig.json b/test/projects/nx/packages/library2/tsconfig.json
@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    }
+  ]
+}
diff --git a/test/projects/nx/packages/library2/tsconfig.lib.json b/test/projects/nx/packages/library2/tsconfig.lib.json
@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "exclude": ["**/*.spec.ts", "**/*.test.ts"],
+  "include": ["**/*.ts"]
+}
diff --git a/test/projects/nx/tsconfig.base.json b/test/projects/nx/tsconfig.base.json
@@ -0,0 +1,23 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "rootDir": ".",
+    "sourceMap": true,
+    "declaration": false,
+    "moduleResolution": "node",
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "importHelpers": true,
+    "target": "es2015",
+    "module": "esnext",
+    "lib": ["es2017", "dom"],
+    "skipLibCheck": true,
+    "skipDefaultLibCheck": true,
+    "baseUrl": ".",
+    "paths": {
+      "library1": ["packages/library1/src/index.ts"],
+      "library2": ["packages/library2/src/index.ts"]
+    }
+  },
+  "exclude": ["node_modules", "tmp"]
+}
diff --git a/test/projects/nx/workspace.json b/test/projects/nx/workspace.json
@@ -0,0 +1,7 @@
+{
+  "version": 2,
+  "projects": {
+    "library1": "packages/library1",
+    "library2": "packages/library2"
+  }
+}
diff --git a/test/projects/specific/yarn.lock b/test/projects/specific/yarn.lock
diff --git a/test/tests/nx.test.ts b/test/tests/nx.test.ts
@@ -0,0 +1,71 @@
+import ts from "typescript";
+import { nxTransformerPlugin } from "../../src";
+import path from "path";
+import { projectsPaths } from "../config";
+import { execSync } from "child_process";
+import { readFileSync, rmSync } from "fs";
+import * as transformerModule from "../../src/transformer";
+
+/* ****************************************************************************************************************** *
+ * Tests
+ * ****************************************************************************************************************** */
+
+describe(`NX Transformer`, () => {
+  describe("Plugin", () => {
+    let mockedTransformer: jest.SpyInstance;
+
+    const program: any = { x: 1 };
+
+    beforeAll(async () => {
+      mockedTransformer = jest.spyOn(transformerModule, "default").mockReturnValue(<any>(() => {}));
+    });
+    afterAll(() => {
+      mockedTransformer.mockClear();
+    });
+    beforeEach(() => {
+      mockedTransformer.mockReset();
+    });
+
+    test(`Before properly routes transform`, () => {
+      const config: any = { a: 2 };
+
+      nxTransformerPlugin.before(config, program);
+
+      expect(mockedTransformer).toBeCalledTimes(1);
+      expect(mockedTransformer.mock.lastCall).toHaveLength(2);
+
+      const [recProgram, recConfig] = mockedTransformer.mock.lastCall;
+      expect(recProgram).toBe(program);
+      expect(recConfig).toStrictEqual(config);
+    });
+
+    test(`After properly routes transform`, () => {
+      const config: any = { a: 2, afterDeclarations: true };
+
+      nxTransformerPlugin.afterDeclarations(config, program);
+
+      expect(mockedTransformer).toBeCalledTimes(1);
+      expect(mockedTransformer.mock.lastCall).toHaveLength(2);
+
+      const [recProgram, recConfig] = mockedTransformer.mock.lastCall;
+      expect(recProgram).toBe(program);
+      expect(recConfig).toStrictEqual({ ...config, afterDeclarations: true });
+    });
+  });
+
+  describe(`(e2e) Works in NX project`, () => {
+    const projectRoot = ts.normalizePath(path.join(projectsPaths, "nx"));
+
+    // TODO - Investigate ways to do without emit
+    test(`Transformer works for emitted declaration`, () => {
+      execSync("yarn run build", { cwd: projectRoot });
+
+      try {
+        const file = readFileSync(`${projectRoot}/dist/library1/packages/library1/src/index.d.ts`, "utf8");
+        expect(file).toMatch(/import { name as library2Name } from "..\/..\/library2\/src";/);
+      } finally {
+        rmSync(`${projectRoot}/dist`, { recursive: true, force: true });
+      }
+    });
+  });
+});
diff --git a/test/yarn.lock b/test/yarn.lock
diff --git a/types/index.d.ts b/types/index.d.ts
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+'use strict'`
	`2`	`+module.exports = require('./').nxTransformerPlugin;`
Original file line number	Diff line number	Diff line change
`@@ -3,3 +3,4 @@ export default transformer;`
`3`	`3`
`4`	`4`	`export { TsTransformPathsConfig } from "./types";`
`5`	`5`	`export { register } from "./register";`
	`6`	`+export { nxTransformerPlugin } from "./plugins";`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export * from "./nx-transformer-plugin";`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "name": "library1",
 +  "version": "0.0.1"
 +}