fix: include eventual compilerOptions.paths changes to the check opti…

…on (#38)
eBayClassifiedsGroup · Nov 29, 2023 · e67433c · e67433c
1 parent 3ba9ae6
commit e67433c
Show file tree

Hide file tree

Showing 26 changed files with 681 additions and 64 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "update-ts-references",
-  "version": "3.2.0",
+  "version": "3.2.1",
   "description": "Updates TypeScript references automatically while using workspaces",
   "bin": "src/index.js",
   "scripts": {

diff --git a/src/update-ts-references.js b/src/update-ts-references.js
@@ -187,6 +187,8 @@ const updateTsConfig = (
         let isEqual = false;
         try {
             assert.deepEqual(JSON.parse(JSON.stringify(currentReferences)), mergedReferences);
+            if (createPathMappings)
+                assert.deepEqual(JSON.parse(JSON.stringify(config?.compilerOptions?.paths ?? {})), paths);
             isEqual = true;
         } catch (e) {
             // ignore me
@@ -195,10 +197,11 @@ const updateTsConfig = (
             if (check === false) {
 
                 const compilerOptions = config?.compilerOptions ?? {};
-                if (createPathMappings && paths && Object.keys(paths).length > 0)
-                    assign(compilerOptions, {
-                        paths
-                    })
+                if (createPathMappings && paths)
+                    assign(compilerOptions,
+                        paths && Object.keys(paths).length > 0 ? {
+                            paths
+                        } : {paths: undefined})
 
                 const newTsConfig = assign(config,
                     {

diff --git a/test-scenarios/ts-paths/workspace-a/tsconfig.json b/test-scenarios/ts-paths/workspace-a/tsconfig.json
@@ -1,6 +1,15 @@
 {
   "compilerOptions": {
     "outDir": "dist",
-    "rootDir": "src"
-  }
+    "rootDir": "src",
+    "paths": { "replace-me": ["../utils/old-one/src"]},
+  },
+  "references": [
+    {
+      "path": "../utils/foos/foo-a"
+    },
+    {
+      "path": "../workspace-b"
+    }
+  ]
 }
diff --git a/test-scenarios/yarn-ws-check-paths-no-changes/package.json b/test-scenarios/yarn-ws-check-paths-no-changes/package.json
@@ -0,0 +1,14 @@
+{
+  "name": "yarn-workspace",
+  "version": "0.0.1",
+  "private": true,
+  "workspaces": [
+    "workspace-a",
+    "workspace-b",
+    "shared/*",
+    "utils/**"
+  ],
+  "devDependencies": {
+    "typescript": "latest"
+  }
+}
diff --git a/test-scenarios/yarn-ws-check-paths-no-changes/tsconfig.json b/test-scenarios/yarn-ws-check-paths-no-changes/tsconfig.json
@@ -0,0 +1,19 @@
+{
+  "files": [],
+  "compilerOptions": {
+    "composite": true,
+    "paths": { "foo-b": ["utils/foos/foo-b/src"] }
+  },
+  "references": [
+    {
+      "path": "workspace-a"
+    },
+    {
+      "path": "workspace-b"
+    },
+    {
+      "path": "utils/foos/foo-a"
+    },
+
+  ]
+}
diff --git a/test-scenarios/yarn-ws-check-paths-no-changes/utils/foos/foo-a/package.json b/test-scenarios/yarn-ws-check-paths-no-changes/utils/foos/foo-a/package.json
@@ -0,0 +1,7 @@
+{
+  "name": "foo-a",
+  "version": "1.0.0",
+  "dependencies": {
+    "foo-b": "1.0.0"
+  }
+}
diff --git a/test-scenarios/yarn-ws-check-paths-no-changes/utils/foos/foo-a/tsconfig.json b/test-scenarios/yarn-ws-check-paths-no-changes/utils/foos/foo-a/tsconfig.json
@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  }
+}
diff --git a/test-scenarios/yarn-ws-check-paths-no-changes/utils/foos/foo-b/package.json b/test-scenarios/yarn-ws-check-paths-no-changes/utils/foos/foo-b/package.json
@@ -0,0 +1,4 @@
+{
+  "name": "foo-b",
+  "version": "1.0.0"
+}
diff --git a/test-scenarios/yarn-ws-check-paths-no-changes/workspace-a/package.json b/test-scenarios/yarn-ws-check-paths-no-changes/workspace-a/package.json
@@ -0,0 +1,10 @@
+{
+  "name": "workspace-a",
+  "version": "1.0.0",
+  "dependencies": {
+    "workspace-b": "1.0.0"
+  },
+  "devDependencies": {
+      "foo-a": "1.0.0"
+  }
+}
diff --git a/test-scenarios/yarn-ws-check-paths-no-changes/workspace-a/tsconfig.json b/test-scenarios/yarn-ws-check-paths-no-changes/workspace-a/tsconfig.json
@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+    "paths": { "foo-a": ["../utils/foos/foo-a/src"], "workspace-b": ["../workspace-b/src"]}
+    },
+  "references": [
+    {
+      "path": "../utils/foos/foo-a"
+    },
+    {
+      "path": "../workspace-b"
+    }
+  ]
+}
diff --git a/test-scenarios/yarn-ws-check-paths-no-changes/workspace-b/package.json b/test-scenarios/yarn-ws-check-paths-no-changes/workspace-b/package.json
@@ -0,0 +1,10 @@
+{
+  "name": "workspace-b",
+  "version": "1.0.0",
+  "dependencies": {
+    "cross-env": "5.0.5"
+  },
+  "devDependencies": {
+    "foo-b": "1.0.0"
+  }
+}
diff --git a/test-scenarios/yarn-ws-check-paths-no-changes/workspace-b/tsconfig.json b/test-scenarios/yarn-ws-check-paths-no-changes/workspace-b/tsconfig.json
@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  }
+}
diff --git a/test-scenarios/yarn-ws-check-paths-no-changes/yarn.lock b/test-scenarios/yarn-ws-check-paths-no-changes/yarn.lock
@@ -0,0 +1,72 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+cross-env@5.0.5:
+  version "5.0.5"
+  resolved "https://registry.npmjs.org/cross-env/-/cross-env-5.0.5.tgz#4383d364d9660873dd185b398af3bfef5efffef3"
+  integrity sha1-Q4PTZNlmCHPdGFs5ivO/717//vM=
+  dependencies:
+    cross-spawn "^5.1.0"
+    is-windows "^1.0.0"
+
+cross-spawn@^5.1.0:
+  version "5.1.0"
+  resolved "https://registry.npmjs.org/cross-spawn/-/cross-spawn-5.1.0.tgz#e8bd0efee58fcff6f8f94510a0a554bbfa235449"
+  integrity sha1-6L0O/uWPz/b4+UUQoKVUu/ojVEk=
+  dependencies:
+    lru-cache "^4.0.1"
+    shebang-command "^1.2.0"
+    which "^1.2.9"
+
+is-windows@^1.0.0:
+  version "1.0.2"
+  resolved "https://registry.npmjs.org/is-windows/-/is-windows-1.0.2.tgz#d1850eb9791ecd18e6182ce12a30f396634bb19d"
+  integrity sha512-eXK1UInq2bPmjyX6e3VHIzMLobc4J94i4AWn+Hpq3OU5KkrRC96OAcR3PRJ/pGu6m8TRnBHP9dkXQVsT/COVIA==
+
+isexe@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz#e8fbf374dc556ff8947a10dcb0572d633f2cfa10"
+  integrity sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=
+
+lru-cache@^4.0.1:
+  version "4.1.5"
+  resolved "https://registry.npmjs.org/lru-cache/-/lru-cache-4.1.5.tgz#8bbe50ea85bed59bc9e33dcab8235ee9bcf443cd"
+  integrity sha512-sWZlbEP2OsHNkXrMl5GYk/jKk70MBng6UU4YI/qGDYbgf6YbP4EvmqISbXCoJiRKs+1bSpFHVgQxvJ17F2li5g==
+  dependencies:
+    pseudomap "^1.0.2"
+    yallist "^2.1.2"
+
+pseudomap@^1.0.2:
+  version "1.0.2"
+  resolved "https://registry.npmjs.org/pseudomap/-/pseudomap-1.0.2.tgz#f052a28da70e618917ef0a8ac34c1ae5a68286b3"
+  integrity sha1-8FKijacOYYkX7wqKw0wa5aaChrM=
+
+shebang-command@^1.2.0:
+  version "1.2.0"
+  resolved "https://registry.npmjs.org/shebang-command/-/shebang-command-1.2.0.tgz#44aac65b695b03398968c39f363fee5deafdf1ea"
+  integrity sha1-RKrGW2lbAzmJaMOfNj/uXer98eo=
+  dependencies:
+    shebang-regex "^1.0.0"
+
+shebang-regex@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.npmjs.org/shebang-regex/-/shebang-regex-1.0.0.tgz#da42f49740c0b42db2ca9728571cb190c98efea3"
+  integrity sha1-2kL0l0DAtC2yypcoVxyxkMmO/qM=
+
+typescript@latest:
+  version "4.0.5"
+  resolved "https://registry.npmjs.org/typescript/-/typescript-4.0.5.tgz#ae9dddfd1069f1cb5beb3ef3b2170dd7c1332389"
+  integrity sha512-ywmr/VrTVCmNTJ6iV2LwIrfG1P+lv6luD8sUJs+2eI9NLGigaN+nUQc13iHqisq7bra9lnmUSYqbJvegraBOPQ==
+
+which@^1.2.9:
+  version "1.3.1"
+  resolved "https://registry.npmjs.org/which/-/which-1.3.1.tgz#a45043d54f5805316da8d62f9f50918d3da70b0a"
+  integrity sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==
+  dependencies:
+    isexe "^2.0.0"
+
+yallist@^2.1.2:
+  version "2.1.2"
+  resolved "https://registry.npmjs.org/yallist/-/yallist-2.1.2.tgz#1c11f9218f076089a47dd512f93c6699a6a81d52"
+  integrity sha1-HBH5IY8HYImkfdUS+TxmmaaoHVI=
diff --git a/test-scenarios/yarn-ws-check-paths/package.json b/test-scenarios/yarn-ws-check-paths/package.json
@@ -0,0 +1,14 @@
+{
+  "name": "yarn-workspace",
+  "version": "0.0.1",
+  "private": true,
+  "workspaces": [
+    "workspace-a",
+    "workspace-b",
+    "shared/*",
+    "utils/**"
+  ],
+  "devDependencies": {
+    "typescript": "latest"
+  }
+}
diff --git a/test-scenarios/yarn-ws-check-paths/tsconfig.json b/test-scenarios/yarn-ws-check-paths/tsconfig.json
@@ -0,0 +1,17 @@
+{
+  "files": [],
+  "compilerOptions": {
+    "composite": true
+  },
+  "references": [
+    {
+      "path": "workspace-a"
+    },
+    {
+      "path": "workspace-b"
+    },
+    {
+      "path": "utils/foos/foo-a"
+    },
+  ]
+}
diff --git a/test-scenarios/yarn-ws-check-paths/utils/foos/foo-a/package.json b/test-scenarios/yarn-ws-check-paths/utils/foos/foo-a/package.json
@@ -0,0 +1,7 @@
+{
+  "name": "foo-a",
+  "version": "1.0.0",
+  "dependencies": {
+    "foo-b": "1.0.0"
+  }
+}
diff --git a/test-scenarios/yarn-ws-check-paths/utils/foos/foo-a/tsconfig.json b/test-scenarios/yarn-ws-check-paths/utils/foos/foo-a/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+    "paths": { "remove-me": ["../utils/remove/src"]}
+  }
+}
diff --git a/test-scenarios/yarn-ws-check-paths/utils/foos/foo-b/package.json b/test-scenarios/yarn-ws-check-paths/utils/foos/foo-b/package.json
@@ -0,0 +1,4 @@
+{
+  "name": "foo-b",
+  "version": "1.0.0"
+}
diff --git a/test-scenarios/yarn-ws-check-paths/workspace-a/package.json b/test-scenarios/yarn-ws-check-paths/workspace-a/package.json
@@ -0,0 +1,10 @@
+{
+  "name": "workspace-a",
+  "version": "1.0.0",
+  "dependencies": {
+    "workspace-b": "1.0.0"
+  },
+  "devDependencies": {
+      "foo-a": "1.0.0"
+  }
+}
diff --git a/test-scenarios/yarn-ws-check-paths/workspace-a/tsconfig.json b/test-scenarios/yarn-ws-check-paths/workspace-a/tsconfig.json
@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "references": [
+    {
+      "path": "../utils/foos/foo-a"
+    },
+    {
+      "path": "../workspace-b"
+    }
+  ]
+}
diff --git a/test-scenarios/yarn-ws-check-paths/workspace-b/package.json b/test-scenarios/yarn-ws-check-paths/workspace-b/package.json
@@ -0,0 +1,10 @@
+{
+  "name": "workspace-b",
+  "version": "1.0.0",
+  "dependencies": {
+    "cross-env": "5.0.5"
+  },
+  "devDependencies": {
+    "foo-b": "1.0.0"
+  }
+}
diff --git a/test-scenarios/yarn-ws-check-paths/workspace-b/tsconfig.json b/test-scenarios/yarn-ws-check-paths/workspace-b/tsconfig.json
@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  }
+}
diff --git a/test-scenarios/yarn-ws-check-paths/yarn.lock b/test-scenarios/yarn-ws-check-paths/yarn.lock
@@ -0,0 +1,72 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+cross-env@5.0.5:
+  version "5.0.5"
+  resolved "https://registry.npmjs.org/cross-env/-/cross-env-5.0.5.tgz#4383d364d9660873dd185b398af3bfef5efffef3"
+  integrity sha1-Q4PTZNlmCHPdGFs5ivO/717//vM=
+  dependencies:
+    cross-spawn "^5.1.0"
+    is-windows "^1.0.0"
+
+cross-spawn@^5.1.0:
+  version "5.1.0"
+  resolved "https://registry.npmjs.org/cross-spawn/-/cross-spawn-5.1.0.tgz#e8bd0efee58fcff6f8f94510a0a554bbfa235449"
+  integrity sha1-6L0O/uWPz/b4+UUQoKVUu/ojVEk=
+  dependencies:
+    lru-cache "^4.0.1"
+    shebang-command "^1.2.0"
+    which "^1.2.9"
+
+is-windows@^1.0.0:
+  version "1.0.2"
+  resolved "https://registry.npmjs.org/is-windows/-/is-windows-1.0.2.tgz#d1850eb9791ecd18e6182ce12a30f396634bb19d"
+  integrity sha512-eXK1UInq2bPmjyX6e3VHIzMLobc4J94i4AWn+Hpq3OU5KkrRC96OAcR3PRJ/pGu6m8TRnBHP9dkXQVsT/COVIA==
+
+isexe@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz#e8fbf374dc556ff8947a10dcb0572d633f2cfa10"
+  integrity sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=
+
+lru-cache@^4.0.1:
+  version "4.1.5"
+  resolved "https://registry.npmjs.org/lru-cache/-/lru-cache-4.1.5.tgz#8bbe50ea85bed59bc9e33dcab8235ee9bcf443cd"
+  integrity sha512-sWZlbEP2OsHNkXrMl5GYk/jKk70MBng6UU4YI/qGDYbgf6YbP4EvmqISbXCoJiRKs+1bSpFHVgQxvJ17F2li5g==
+  dependencies:
+    pseudomap "^1.0.2"
+    yallist "^2.1.2"
+
+pseudomap@^1.0.2:
+  version "1.0.2"
+  resolved "https://registry.npmjs.org/pseudomap/-/pseudomap-1.0.2.tgz#f052a28da70e618917ef0a8ac34c1ae5a68286b3"
+  integrity sha1-8FKijacOYYkX7wqKw0wa5aaChrM=
+
+shebang-command@^1.2.0:
+  version "1.2.0"
+  resolved "https://registry.npmjs.org/shebang-command/-/shebang-command-1.2.0.tgz#44aac65b695b03398968c39f363fee5deafdf1ea"
+  integrity sha1-RKrGW2lbAzmJaMOfNj/uXer98eo=
+  dependencies:
+    shebang-regex "^1.0.0"
+
+shebang-regex@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.npmjs.org/shebang-regex/-/shebang-regex-1.0.0.tgz#da42f49740c0b42db2ca9728571cb190c98efea3"
+  integrity sha1-2kL0l0DAtC2yypcoVxyxkMmO/qM=
+
+typescript@latest:
+  version "4.0.5"
+  resolved "https://registry.npmjs.org/typescript/-/typescript-4.0.5.tgz#ae9dddfd1069f1cb5beb3ef3b2170dd7c1332389"
+  integrity sha512-ywmr/VrTVCmNTJ6iV2LwIrfG1P+lv6luD8sUJs+2eI9NLGigaN+nUQc13iHqisq7bra9lnmUSYqbJvegraBOPQ==
+
+which@^1.2.9:
+  version "1.3.1"
+  resolved "https://registry.npmjs.org/which/-/which-1.3.1.tgz#a45043d54f5805316da8d62f9f50918d3da70b0a"
+  integrity sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==
+  dependencies:
+    isexe "^2.0.0"
+
+yallist@^2.1.2:
+  version "2.1.2"
+  resolved "https://registry.npmjs.org/yallist/-/yallist-2.1.2.tgz#1c11f9218f076089a47dd512f93c6699a6a81d52"
+  integrity sha1-HBH5IY8HYImkfdUS+TxmmaaoHVI=