Improve IDE quality of life using tsconfig paths (#574)

jcready · web-flow · commit ee3ff2d94577 · 2023-07-31T21:08:10.000+02:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,7 +2,9 @@
   "name": "root",
   "private": true,
   "devDependencies": {
-    "lerna": "^3.22.1"
+    "@types/jasmine": "^3.5.10",
+    "lerna": "^3.22.1",
+    "typescript": ">=3.8.3 <4"
   },
   "license": "(Apache-2.0 AND BSD-3-Clause)"
 }
diff --git a/packages/grpc-backend/Makefile b/packages/grpc-backend/Makefile
@@ -5,9 +5,9 @@ SPECS := $(shell find spec -name '*.spec.ts')
 default: clean build test
 
 build:
-	@./node_modules/.bin/tsc --project tsconfig.json --module es2015 --outDir build/es2015;
+	@./node_modules/.bin/tsc --project tsconfig.build.json --module es2015 --outDir build/es2015;
 	@echo "es6 done"
-	@./node_modules/.bin/tsc --project tsconfig.json --module commonjs --outDir build/commonjs \
+	@./node_modules/.bin/tsc --project tsconfig.build.json --module commonjs --outDir build/commonjs \
 		--declaration --declarationDir build/types;
 	@echo "cjs done"
 
diff --git a/packages/grpc-backend/tsconfig.build.json b/packages/grpc-backend/tsconfig.build.json
@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "paths": {},
+  }
+}
diff --git a/packages/grpc-backend/tsconfig.json b/packages/grpc-backend/tsconfig.json
@@ -11,6 +11,9 @@
     "moduleResolution": "node",
     "forceConsistentCasingInFileNames": true,
     "skipLibCheck": false,
+    "paths": {
+      "@protobuf-ts/*": ["../*/src"]
+    },
     "lib": [
       "es2017",
       "dom"
diff --git a/packages/grpc-backend/tsconfig.test.json b/packages/grpc-backend/tsconfig.test.json
@@ -7,6 +7,6 @@
   "compilerOptions": {
     "module": "CommonJS",
     "declaration": false,
-    "paths": {}
+    "sourceMap": true
   }
 }
diff --git a/packages/grpc-transport/Makefile b/packages/grpc-transport/Makefile
@@ -5,9 +5,9 @@ SPECS := $(shell find spec -name '*.spec.ts')
 default: clean build test
 
 build:
-	@./node_modules/.bin/tsc --project tsconfig.json --module es2015 --outDir build/es2015;
+	@./node_modules/.bin/tsc --project tsconfig.build.json --module es2015 --outDir build/es2015;
 	@echo "es6 done"
-	@./node_modules/.bin/tsc --project tsconfig.json --module commonjs --outDir build/commonjs \
+	@./node_modules/.bin/tsc --project tsconfig.build.json --module commonjs --outDir build/commonjs \
 		--declaration --declarationDir build/types;
 	@echo "cjs done"
 
diff --git a/packages/grpc-transport/tsconfig.build.json b/packages/grpc-transport/tsconfig.build.json
@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "paths": {},
+  }
+}
diff --git a/packages/grpc-transport/tsconfig.json b/packages/grpc-transport/tsconfig.json
@@ -11,6 +11,9 @@
     "moduleResolution": "node",
     "forceConsistentCasingInFileNames": true,
     "skipLibCheck": false,
+    "paths": {
+      "@protobuf-ts/*": ["../*/src"]
+    },
     "lib": [
       "es2017",
       "dom"
diff --git a/packages/grpc-transport/tsconfig.test.json b/packages/grpc-transport/tsconfig.test.json
@@ -7,6 +7,6 @@
   "compilerOptions": {
     "module": "CommonJS",
     "declaration": false,
-    "paths": {}
+    "sourceMap": true
   }
 }
diff --git a/packages/grpcweb-transport/Makefile b/packages/grpcweb-transport/Makefile
@@ -5,9 +5,9 @@ SPECS := $(shell find spec -name '*.spec.ts')
 default: clean build test
 
 build:
-	@./node_modules/.bin/tsc --project tsconfig.json --module es2015 --outDir build/es2015;
+	@./node_modules/.bin/tsc --project tsconfig.build.json --module es2015 --outDir build/es2015;
 	@echo "es6 done"
-	@./node_modules/.bin/tsc --project tsconfig.json --module commonjs --outDir build/commonjs \
+	@./node_modules/.bin/tsc --project tsconfig.build.json --module commonjs --outDir build/commonjs \
 		--declaration --declarationDir build/types;
 	@echo "cjs done"
 
diff --git a/packages/grpcweb-transport/karma.conf.js b/packages/grpcweb-transport/karma.conf.js
@@ -21,6 +21,11 @@ module.exports = function (config) {
         browsers: ["ChromeHeadless"],
         singleRun: true,
         karmaTypescriptConfig: {
+            coverageOptions: {
+                exclude: [
+                    /(^|\/)spec\//i,
+                ]
+            },
             tsconfig: './tsconfig.test.json'
         },
         client: {
diff --git a/packages/grpcweb-transport/tsconfig.build.json b/packages/grpcweb-transport/tsconfig.build.json
@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "paths": {},
+  }
+}
diff --git a/packages/grpcweb-transport/tsconfig.json b/packages/grpcweb-transport/tsconfig.json
@@ -11,6 +11,9 @@
     "moduleResolution": "node",
     "forceConsistentCasingInFileNames": true,
     "skipLibCheck": false,
+    "paths": {
+      "@protobuf-ts/*": ["../*/src"]
+    },
     "lib": [
       "es2017",
       "dom"
diff --git a/packages/grpcweb-transport/tsconfig.test.json b/packages/grpcweb-transport/tsconfig.test.json
@@ -7,7 +7,6 @@
   "compilerOptions": {
     "sourceMap": true,
     "module": "CommonJS",
-    "declaration": false,
-    "paths": {}
+    "declaration": false
   }
 }
diff --git a/packages/plugin-framework/Makefile b/packages/plugin-framework/Makefile
@@ -7,9 +7,9 @@ SPECS := $(shell find spec -name '*.spec.ts')
 default: clean build test
 
 build:
-	@./node_modules/.bin/tsc --project tsconfig.json --module es2015 --outDir build/es2015;
+	@./node_modules/.bin/tsc --project tsconfig.build.json --module es2015 --outDir build/es2015;
 	@echo "es6 done"
-	@./node_modules/.bin/tsc --project tsconfig.json --module commonjs --outDir build/commonjs \
+	@./node_modules/.bin/tsc --project tsconfig.build.json --module commonjs --outDir build/commonjs \
 		--declaration --declarationDir build/types;
 	@echo "cjs done"
 
diff --git a/packages/plugin-framework/tsconfig.build.json b/packages/plugin-framework/tsconfig.build.json
@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "paths": {},
+  }
+}
diff --git a/packages/plugin-framework/tsconfig.json b/packages/plugin-framework/tsconfig.json
@@ -11,6 +11,9 @@
     "moduleResolution": "node",
     "forceConsistentCasingInFileNames": true,
     "skipLibCheck": false,
+    "paths": {
+      "@protobuf-ts/*": ["../*/src"]
+    },
     "lib": [
       "es2017",
       "dom"
diff --git a/packages/plugin-framework/tsconfig.test.json b/packages/plugin-framework/tsconfig.test.json
@@ -7,10 +7,7 @@
   "compilerOptions": {
     "module": "CommonJS",
     "declaration": false,
-    "paths": {
-      "@protobuf-ts/runtime": [
-        "../runtime"
-      ]
-    }
+    "sourceMap": true,
+    "paths": {}
   }
 }
diff --git a/packages/plugin/spec/protobufts-plugin-long.spec.ts b/packages/plugin/spec/protobufts-plugin-long.spec.ts
@@ -1,6 +1,6 @@
 import {getCodeGeneratorRequest} from "./support/helpers";
 import {ProtobuftsPlugin} from "../src/protobufts-plugin";
-import {GeneratedFile} from "@protobuf-ts/plugin-framework/src";
+import {GeneratedFile} from "@protobuf-ts/plugin-framework";
 
 const stringSnippets = [
     // Message
diff --git a/packages/plugin/tsconfig.build.json b/packages/plugin/tsconfig.build.json
@@ -4,6 +4,9 @@
     "src/protobufts-plugin.ts",
     "src/dump-plugin.ts"
   ],
+  "compilerOptions": {
+    "paths": {},
+  },
   "include": [
     "src/**/*.d.ts"
   ],
diff --git a/packages/plugin/tsconfig.json b/packages/plugin/tsconfig.json
@@ -12,6 +12,9 @@
     "resolveJsonModule": true,
     "forceConsistentCasingInFileNames": true,
     "skipLibCheck": false,
+    "paths": {
+      "@protobuf-ts/*": ["../*/src"]
+    },
     "lib": [
       "es2017",
       "dom"
diff --git a/packages/plugin/tsconfig.test.json b/packages/plugin/tsconfig.test.json
@@ -5,11 +5,11 @@
     "spec/support/*.ts"
   ],
   "compilerOptions": {
+    "skipLibCheck": true,
+    "sourceMap": true,
     "outDir": "/tmp",
     "paths": {
-      "@protobuf-ts/runtime": [
-        "../runtime"
-      ]
-    }
+      "@protobuf-ts/*": ["../*/src"]
+    },
   }
 }
diff --git a/packages/runtime-rpc/Makefile b/packages/runtime-rpc/Makefile
@@ -5,9 +5,9 @@ SPECS := $(shell find spec -name '*.spec.ts')
 default: clean build test
 
 build:
-	@./node_modules/.bin/tsc --project tsconfig.json --module es2015 --outDir build/es2015;
+	@./node_modules/.bin/tsc --project tsconfig.build.json --module es2015 --outDir build/es2015;
 	@echo "es6 done"
-	@./node_modules/.bin/tsc --project tsconfig.json --module commonjs --outDir build/commonjs \
+	@./node_modules/.bin/tsc --project tsconfig.build.json --module commonjs --outDir build/commonjs \
 		--declaration --declarationDir build/types;
 	@echo "cjs done"
 
diff --git a/packages/runtime-rpc/karma.conf.js b/packages/runtime-rpc/karma.conf.js
@@ -21,6 +21,11 @@ module.exports = function (config) {
         browsers: ["ChromeHeadless"],
         singleRun: true,
         karmaTypescriptConfig: {
+            coverageOptions: {
+                exclude: [
+                    /(^|\/)spec\//i,
+                ]
+            },
             tsconfig: './tsconfig.test.json'
         },
         client: {
diff --git a/packages/runtime-rpc/tsconfig.build.json b/packages/runtime-rpc/tsconfig.build.json
@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "paths": {},
+  }
+}
diff --git a/packages/runtime-rpc/tsconfig.json b/packages/runtime-rpc/tsconfig.json
@@ -17,6 +17,9 @@
     // svelte requires this option
     "importsNotUsedAsValues": "error",
 
+    "paths": {
+      "@protobuf-ts/*": ["../*/src"]
+    },
     "lib": [
       "es2017",
       "dom",
diff --git a/packages/runtime-rpc/tsconfig.test.json b/packages/runtime-rpc/tsconfig.test.json
@@ -7,6 +7,6 @@
   "compilerOptions": {
     "module": "CommonJS",
     "declaration": false,
-    "paths": {}
+    "sourceMap": true
   }
 }
diff --git a/packages/runtime/karma.conf.js b/packages/runtime/karma.conf.js
@@ -21,6 +21,11 @@ module.exports = function (config) {
         browsers: ["ChromeHeadless"],
         singleRun: true,
         karmaTypescriptConfig: {
+            coverageOptions: {
+                exclude: [
+                    /(^|\/)spec\//i,
+                ]
+            },
             tsconfig: './tsconfig.test.json'
         },
         client: {
diff --git a/packages/runtime/tsconfig.base.json b/packages/runtime/tsconfig.base.json
@@ -19,10 +19,8 @@
     ],
 
     "paths": {
-      "@protobuf-ts/runtime": [
-        "./src"
-      ]
-    }
+      "@protobuf-ts/*": ["../*/src"]
+    },
 
   }
 }
diff --git a/packages/runtime/tsconfig.build.json b/packages/runtime/tsconfig.build.json
@@ -5,5 +5,6 @@
   ],
   "include": [],
   "compilerOptions": {
+    "paths": {},
   }
 }
diff --git a/packages/runtime/tsconfig.test.json b/packages/runtime/tsconfig.test.json
@@ -6,6 +6,7 @@
     "spec/**/*.ts"
   ],
   "compilerOptions": {
+    "sourceMap": true,
     "module": "CommonJS"
   }
 }
diff --git a/packages/test-generated/Makefile b/packages/test-generated/Makefile
@@ -19,7 +19,7 @@ clean:
 
 test-spec:
 	@./node_modules/.bin/ts-node \
-		--project tsconfig.json \
+		--project tsconfig.test.json \
 		--require tsconfig-paths/register \
 		./node_modules/.bin/jasmine --helper="spec/support/reporter.ts" \
 		$(SPECS)
diff --git a/packages/test-generated/tsconfig.bigint.json b/packages/test-generated/tsconfig.bigint.json
@@ -1,5 +1,5 @@
 {
-  "extends": "./tsconfig.json",
+  "extends": "./tsconfig.test.json",
   "compilerOptions": {
 
     // compiler requires this target for bigint
diff --git a/packages/test-generated/tsconfig.json b/packages/test-generated/tsconfig.json
diff --git a/packages/test-generated/tsconfig.test.json b/packages/test-generated/tsconfig.test.json
diff --git a/packages/twirp-transport/Makefile b/packages/twirp-transport/Makefile
diff --git a/packages/twirp-transport/karma.conf.js b/packages/twirp-transport/karma.conf.js
diff --git a/packages/twirp-transport/tsconfig.build.json b/packages/twirp-transport/tsconfig.build.json
diff --git a/packages/twirp-transport/tsconfig.json b/packages/twirp-transport/tsconfig.json
diff --git a/packages/twirp-transport/tsconfig.test.json b/packages/twirp-transport/tsconfig.test.json

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,6 @@`
`7`	`7`	`"compilerOptions": {`
`8`	`8`	`"module": "CommonJS",`
`9`	`9`	`"declaration": false,`
`10`		`- "paths": {}`
	`10`	`+ "sourceMap": true`
`11`	`11`	`}`
`12`	`12`	`}`