feat: Added exclude option to allow excluding transformation of matching resolved paths

Author: nonara

package.json

@@ -56,6 +56,7 @@
   },
   "devDependencies": {
     "@types/jest": "^24.0.15",
+    "@types/minimatch": "^3.0.3",
     "@types/node": "^12.0.2",
     "jest": "^24.8.0",
     "prettier": "^2.1.2",
@@ -70,5 +71,8 @@
   },
   "peerDependencies": {
     "typescript": ">=3.6.5"
+  },
+  "dependencies": {
+    "minimatch": "^3.0.4"
   }
 }

src/transformer.ts

@@ -6,6 +6,7 @@ import { cast, getImplicitExtensions } from "./utils";
 import { TsTransformPathsConfig, TsTransformPathsContext, TypeScriptThree, VisitorContext } from "./types";
 import { nodeVisitor } from "./visitor";
 import { createHarmonyFactory } from "./utils/harmony-factory";
+import { Minimatch } from "minimatch";
 
 /* ****************************************************************************************************************** *
  * Transformer
@@ -34,6 +35,7 @@ export default function transformer(
       transformationContext,
       tsInstance,
       tsThreeInstance: cast<TypeScriptThree>(tsInstance),
+      excludeMatchers: config.exclude?.map((globPattern) => new Minimatch(globPattern, { matchBase: true })),
     };
 
     return (sourceFile: ts.SourceFile) => {

src/types.ts

@@ -2,6 +2,7 @@ import tsThree from "./declarations/typescript3";
 import ts, { CompilerOptions } from "typescript";
 import { PluginConfig } from "ts-patch";
 import { HarmonyFactory } from "./utils/harmony-factory";
+import { IMinimatch } from "minimatch";
 
 /* ****************************************************************************************************************** */
 // region: TS Types
@@ -20,6 +21,7 @@ export type ImportOrExportClause = ts.ImportDeclaration["importClause"] | ts.Exp
 
 export interface TsTransformPathsConfig extends PluginConfig {
   readonly useRootDirs?: boolean;
+  readonly exclude?: string[];
 }
 
 // endregion
@@ -45,6 +47,7 @@ export interface TsTransformPathsContext {
   readonly elisionMap: Map<ts.SourceFile, Map<ImportOrExportDeclaration, ImportOrExportDeclaration>>;
   readonly transformationContext: ts.TransformationContext;
   readonly rootDirs?: string[];
+  readonly excludeMatchers: IMinimatch[] | undefined;
 }
 
 export interface VisitorContext extends TsTransformPathsContext {

src/utils/resolve-path-update-node.ts

@@ -57,11 +57,18 @@ export function resolvePathAndUpdateNode(
       }
     }
 
-    /* Remove extension if implicit */
     outputPath = tsInstance.normalizePath(
       path.join(path.relative(filePath, modulePath), path.basename(resolvedFileName))
     );
+
+    /* Check if matches exclusion */
+    if (context.excludeMatchers)
+      for (const matcher of context.excludeMatchers)
+        if (matcher.match(outputPath)) return node;
+
+    // Remove extension if implicit
     if (extension && implicitExtensions.includes(extension)) outputPath = outputPath.slice(0, -extension.length);
+
     if (!outputPath) return node;
 
     outputPath = outputPath[0] === "." ? outputPath : `./${outputPath}`;

test/package.json

@@ -12,6 +12,6 @@
     "ts-patch": "link:../node_modules/ts-patch"
   },
   "workspaces": [
-    "packages/*"
+    "projects/*"
   ]
 }

test/projects/specific/src/excluded-file.ts

@@ -0,0 +1 @@
+export type DD = number;

test/projects/specific/src/excluded/ex.ts

@@ -0,0 +1 @@
+export type BB = number;

test/projects/specific/src/index.ts

@@ -14,3 +14,8 @@ import(
    */
   "#root/dir/gen-file"
 );
+
+export { BB } from "#exclusion/ex";
+export { DD } from "#root/excluded-file";
+
+export const b = 3;

test/projects/specific/tsconfig.json

@@ -7,13 +7,15 @@
     "rootDir": ".",
     "module": "ESNext",
     "esModuleInterop": true,
+    "moduleResolution": "node",
     "declaration": true,
 
     "rootDirs": [ "src", "generated" ],
 
     "baseUrl": ".",
     "paths": {
-      "#root/*": [ "./src/*", "./generated/*" ]
+      "#root/*": [ "./src/*", "./generated/*" ],
+      "#exclusion/*": [ "./src/excluded/*" ]
     }
   }
 }

test/tests/transformer/specific.test.ts

@@ -3,6 +3,7 @@ import {} from "ts-expose-internals";
 import * as path from "path";
 import { createTsProgram, EmittedFiles, getEmitResult } from "../../utils";
 import { projectsPaths, ts, tsModules, tTypeScript } from "../config";
+import { TsTransformPathsConfig } from "../../../src/types";
 
 /* ****************************************************************************************************************** *
  * Config
@@ -23,17 +24,32 @@ describe(`Transformer -> Specific Cases`, () => {
   const srcFile = ts.normalizePath(path.join(projectRoot, "src/dir/src-file.ts"));
   const indexFile = ts.normalizePath(path.join(projectRoot, "src/index.ts"));
   const typeElisionIndex = ts.normalizePath(path.join(projectRoot, "src/type-elision/index.ts"));
+  const baseConfig: TsTransformPathsConfig = { exclude: ["**/excluded/**", "excluded-file.*"] };
 
   describe.each(testTsModules)(`TypeScript %s`, (s, tsInstance) => {
     let rootDirsEmit: EmittedFiles;
     let normalEmit: EmittedFiles;
     const tsVersion = +tsInstance.versionMajorMinor.split(".").slice(0, 2).join("");
 
     beforeAll(() => {
-      const program = createTsProgram({ tsInstance, tsConfigFile, pluginOptions: { useRootDirs: false } });
+      const program = createTsProgram({
+        tsInstance,
+        tsConfigFile,
+        pluginOptions: {
+          ...baseConfig,
+          useRootDirs: false,
+        },
+      });
       normalEmit = getEmitResult(program);
 
-      const rootDirsProgram = createTsProgram({ tsInstance, tsConfigFile, pluginOptions: { useRootDirs: true } });
+      const rootDirsProgram = createTsProgram({
+        tsInstance,
+        tsConfigFile,
+        pluginOptions: {
+          ...baseConfig,
+          useRootDirs: true,
+        },
+      });
       rootDirsEmit = getEmitResult(rootDirsProgram);
     });
 
@@ -44,6 +60,56 @@ describe(`Transformer -> Specific Cases`, () => {
       expect(rootDirsEmit[indexFile].dts).toMatch(`export { A } from "./dir/src-file"`);
     });
 
+    test(`(useRootDirs: false) Ignores rootDirs`, () => {
+      expect(normalEmit[genFile].dts).toMatch(`import "../../src/dir/src-file"`);
+      expect(normalEmit[srcFile].dts).toMatch(`import "../../generated/dir/gen-file"`);
+      expect(normalEmit[indexFile].dts).toMatch(`export { B } from "../generated/dir/gen-file"`);
+      expect(normalEmit[indexFile].dts).toMatch(`export { A } from "./dir/src-file"`);
+    });
+
+      test(`(exclude) Doesn't transform for exclusion patterns`, () => {
+        expect(rootDirsEmit[indexFile].dts).toMatch(
+          /export { BB } from "#exclusion\/ex";\s*export { DD } from "#root\/excluded-file";/
+        );
+      });
+    });
+
+    describe(`Tags`, () => {
+      test(`(@no-transform-path) Doesn't transform path`, () => {
+        const regex = /^import \* as skipTransform\d from "#root\/index"/gm;
+        const expectedLength = tsInstance.versionMajorMinor === '3.6' ? 8 : 16;
+        const matches = [
+          ...(normalEmit[tagFile].dts.match(regex) ?? []),
+          ...(rootDirsEmit[tagFile].dts.match(regex) ?? []),
+          ...(normalEmit[tagFile].js.match(regex) ?? []),
+          ...(rootDirsEmit[tagFile].js.match(regex) ?? []),
+        ];
+        expect(matches).toHaveLength(expectedLength);
+      });
+
+      test(`(@transform-path) Transforms path with explicit value`, () => {
+        const regex1 = /^import \* as explicitTransform\d from "\.\/dir\/src-file"/gm;
+        const regex2 = /^import \* as explicitTransform\d from "http:\/\/www\.go\.com\/react\.js"/gm;
+        const expectedLength = tsInstance.versionMajorMinor === '3.6' ? 4 : 8;
+
+        const matches1 = [
+          ...(normalEmit[tagFile].dts.match(regex1) ?? []),
+          ...(rootDirsEmit[tagFile].dts.match(regex1) ?? []),
+          ...(normalEmit[tagFile].js.match(regex1) ?? []),
+          ...(rootDirsEmit[tagFile].js.match(regex1) ?? []),
+        ];
+        expect(matches1).toHaveLength(expectedLength);
+
+        const matches2 = [
+          ...(normalEmit[tagFile].dts.match(regex2) ?? []),
+          ...(rootDirsEmit[tagFile].dts.match(regex2) ?? []),
+          ...(normalEmit[tagFile].js.match(regex2) ?? []),
+          ...(rootDirsEmit[tagFile].js.match(regex2) ?? []),
+        ];
+        expect(matches2).toHaveLength(expectedLength);
+      });
+    });
+
     test(`Does not resolve external modules`, () => {
       expect(normalEmit[indexFile].dts).toMatch(`import "ts-expose-internals";`);
       expect(rootDirsEmit[indexFile].dts).toMatch(`import "ts-expose-internals";`);
@@ -66,12 +132,5 @@ describe(`Transformer -> Specific Cases`, () => {
         /\/\/ comment 1\r?\n\s*\r?\n\/\*\r?\n\s*comment 2\r?\n\s*\*\/\r?\n\s*"\.\.\/generated\/dir\/gen-file"/
       );
     });
-
-    test(`(useRootDirs: false) Ignores rootDirs`, () => {
-      expect(normalEmit[genFile].dts).toMatch(`import "../../src/dir/src-file"`);
-      expect(normalEmit[srcFile].dts).toMatch(`import "../../generated/dir/gen-file"`);
-      expect(normalEmit[indexFile].dts).toMatch(`export { B } from "../generated/dir/gen-file"`);
-      expect(normalEmit[indexFile].dts).toMatch(`export { A } from "./dir/src-file"`);
-    });
   });
 });

test/yarn.lock

@@ -207,6 +207,10 @@ ts-expose-internals@^4.1.2:
   resolved "https://registry.yarnpkg.com/ts-expose-internals/-/ts-expose-internals-4.1.2.tgz#c89a64be5b7ae6634d2f0f25dffa798e2931d136"
   integrity sha512-J5xYsQocO5tjP2UMkGlOb5U+joore0AiL1drA5bMPganlQR/9gPmQVO55pQDeHVfy8OATqZaBT5JweyjI6f3eA==
 
+"ts-patch-alias@link:../node_modules/ts-patch":
+  version "0.0.0"
+  uid ""
+
 "ts-patch@link:../node_modules/ts-patch":
   version "0.0.0"
   uid ""

yarn.lock

@@ -405,6 +405,11 @@
   dependencies:
     jest-diff "^24.3.0"
 
+"@types/minimatch@^3.0.3":
+  version "3.0.3"
+  resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.3.tgz#3dca0e3f33b200fc7d1139c0cd96c1268cadfd9d"
+  integrity sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA==
+
 "@types/minimist@^1.2.0":
   version "1.2.1"
   resolved "https://registry.yarnpkg.com/@types/minimist/-/minimist-1.2.1.tgz#283f669ff76d7b8260df8ab7a4262cc83d988256"