ref(build): Add build/types to tarballs and adjust types entry points (#4824)

Lms24 · web-flow · commit faaacb869a25 · 2022-03-31T10:20:54.000+02:00
* All tarballs now include the `build/types` directory. All `.npmignore`s were adjusted to include this directory. * The `types` entry point in all `package.json`s are now adjusted to the new types directory Proper bugfix for 6.19.0 regression: With PR #4724, we introduced separate building of type declaration files which would be written to `<sdk>/build/types`. Furthermore, we adjusted the `types` entry point in the `package.json`s to this new directory. To avoid a breaking change, we kept type declarations in `dist` and `esm`. However, a bug in this PR caused a small regression in most of our SDKs: The new types directory was not included in most of our SDK tarballs. Subsequently, we released a hot fix via #4745 which simply reset the entry points back to their previous path (`dist/index.d.ts`) in all SDKs. Additional adjustments w.r.t. creating tarballs to improve consistency: * Browser: Adjusted `postbuild.sh` to copy `.npmignore` to `./build` * Gatsby: Use `.npmignore` instead of `files` property in `package.json` * Utils: Changed `.npmignore` to be more similar to our other packages * WASM: Changed `.npmignore` to be more similar to our other packages * Next.js: Added `.npmignore`
diff --git a/packages/angular/.npmignore b/packages/angular/.npmignore
@@ -1,4 +1,4 @@
 *
 !/dist/**/*
 !/esm/**/*
-*.tsbuildinfo
+!/build/types/**/*
diff --git a/packages/angular/package.json b/packages/angular/package.json
@@ -11,7 +11,7 @@
   },
   "main": "dist/index.js",
   "module": "esm/index.js",
-  "types": "dist/index.d.ts",
+  "types": "build/types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
diff --git a/packages/browser/.npmignore b/packages/browser/.npmignore
@@ -1,5 +1,12 @@
+# Info: the paths in this file are adjusted to match once this
+# file is copied to `./build`. This is done by a postbuild script
+# located in sentry-javascript/scripts/postbuild.sh
+
 *
+
+# TODO remove bundles in v7
+!/bundles/**/*
+
 !/dist/**/*
-!/build/**/*
+!/types/**/*
 !/esm/**/*
-*.tsbuildinfo
diff --git a/packages/browser/package.json b/packages/browser/package.json
@@ -11,7 +11,7 @@
   },
   "main": "build/dist/index.js",
   "module": "build/esm/index.js",
-  "types": "build/dist/index.d.ts",
+  "types": "build/types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
diff --git a/packages/core/.npmignore b/packages/core/.npmignore
@@ -1,4 +1,4 @@
 *
 !/dist/**/*
 !/esm/**/*
-*.tsbuildinfo
+!/build/types/**/*
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -11,7 +11,7 @@
   },
   "main": "dist/index.js",
   "module": "esm/index.js",
-  "types": "dist/index.d.ts",
+  "types": "build/types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
diff --git a/packages/gatsby/.npmignore b/packages/gatsby/.npmignore
@@ -0,0 +1,6 @@
+*
+!/dist/**/*
+!/esm/**/*
+!/build/types/**/*
+!gatsby-browser.js
+!gatsby-node.js
diff --git a/packages/gatsby/package.json b/packages/gatsby/package.json
@@ -15,13 +15,7 @@
   },
   "main": "dist/index.js",
   "module": "esm/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "/dist",
-    "/esm",
-    "gatsby-browser.js",
-    "gatsby-node.js"
-  ],
+  "types": "build/types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
diff --git a/packages/hub/.npmignore b/packages/hub/.npmignore
@@ -1,4 +1,4 @@
 *
 !/dist/**/*
 !/esm/**/*
-*.tsbuildinfo
+!/build/types/**/*
diff --git a/packages/hub/package.json b/packages/hub/package.json
@@ -11,7 +11,7 @@
   },
   "main": "dist/index.js",
   "module": "esm/index.js",
-  "types": "dist/index.d.ts",
+  "types": "build/types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
diff --git a/packages/integrations/.npmignore b/packages/integrations/.npmignore
@@ -2,4 +2,3 @@
 !/dist/**/*
 !/build/**/*
 !/esm/**/*
-*.tsbuildinfo
diff --git a/packages/integrations/package.json b/packages/integrations/package.json
@@ -14,7 +14,7 @@
   },
   "main": "dist/index.js",
   "module": "esm/index.js",
-  "types": "dist/index.d.ts",
+  "types": "build/types/index.d.ts",
   "dependencies": {
     "@sentry/types": "6.19.3",
     "@sentry/utils": "6.19.3",
diff --git a/packages/minimal/.npmignore b/packages/minimal/.npmignore
@@ -1,4 +1,4 @@
 *
 !/dist/**/*
 !/esm/**/*
-*.tsbuildinfo
+!/build/types/**/*
diff --git a/packages/minimal/package.json b/packages/minimal/package.json
@@ -11,7 +11,7 @@
   },
   "main": "dist/index.js",
   "module": "esm/index.js",
-  "types": "dist/index.d.ts",
+  "types": "build/types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
diff --git a/packages/nextjs/.npmignore b/packages/nextjs/.npmignore
@@ -0,0 +1,4 @@
+*
+!/dist/**/*
+!/esm/**/*
+!/build/types/**/*
diff --git a/packages/nextjs/package.json b/packages/nextjs/package.json
@@ -12,7 +12,7 @@
   "main": "./dist/index.server.js",
   "module": "./esm/index.server.js",
   "browser": "./esm/index.client.js",
-  "types": "./esm/index.server.d.ts",
+  "types": "./build/types/index.server.d.ts",
   "publishConfig": {
     "access": "public"
   },
diff --git a/packages/node/.npmignore b/packages/node/.npmignore
@@ -1,4 +1,4 @@
 *
 !/dist/**/*
 !/esm/**/*
-*.tsbuildinfo
+!build/types/**/*
diff --git a/packages/node/package.json b/packages/node/package.json
@@ -11,7 +11,7 @@
   },
   "main": "dist/index.js",
   "module": "esm/index.js",
-  "types": "dist/index.d.ts",
+  "types": "build/types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
diff --git a/packages/react/.npmignore b/packages/react/.npmignore
@@ -1,4 +1,4 @@
 *
 !/dist/**/*
 !/esm/**/*
-*.tsbuildinfo
+!/build/types/**/*
diff --git a/packages/react/package.json b/packages/react/package.json
@@ -11,7 +11,7 @@
   },
   "main": "dist/index.js",
   "module": "esm/index.js",
-  "types": "dist/index.d.ts",
+  "types": "build/types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
diff --git a/packages/serverless/.npmignore b/packages/serverless/.npmignore
@@ -1,4 +1,4 @@
 *
 !/dist/**/*
 !/esm/**/*
-*.tsbuildinfo
+!/build/**/*
diff --git a/packages/serverless/package.json b/packages/serverless/package.json
@@ -11,7 +11,7 @@
   },
   "main": "dist/index.js",
   "module": "esm/index.js",
-  "types": "dist/index.d.ts",
+  "types": "build/types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
diff --git a/packages/tracing/.npmignore b/packages/tracing/.npmignore
@@ -2,4 +2,3 @@
 !/dist/**/*
 !/build/**/*
 !/esm/**/*
-*.tsbuildinfo
diff --git a/packages/tracing/package.json b/packages/tracing/package.json
@@ -11,7 +11,7 @@
   },
   "main": "dist/index.js",
   "module": "esm/index.js",
-  "types": "dist/index.d.ts",
+  "types": "build/types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
diff --git a/packages/types/.npmignore b/packages/types/.npmignore
@@ -1,4 +1,4 @@
 *
 !/dist/**/*
 !/esm/**/*
-*.tsbuildinfo
+!/build/types/**/*
diff --git a/packages/types/package.json b/packages/types/package.json
@@ -11,7 +11,7 @@
   },
   "main": "dist/index.js",
   "module": "esm/index.js",
-  "types": "dist/index.d.ts",
+  "types": "build/types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
diff --git a/packages/typescript/.npmignore b/packages/typescript/.npmignore
@@ -1,4 +1,3 @@
 *
 !/tsconfig.json
 !/tslint.json
-*.tsbuildinfo
diff --git a/packages/utils/.npmignore b/packages/utils/.npmignore
@@ -1,6 +1,4 @@
 *
-!*.js.map
-!*.d.ts
-!*.js
 !/esm/**/*
-jest.config.js
+!/dist/**/*
+!/build/types/**/*
diff --git a/packages/utils/package.json b/packages/utils/package.json
@@ -11,7 +11,7 @@
   },
   "main": "dist/index.js",
   "module": "esm/index.js",
-  "types": "dist/index.d.ts",
+  "types": "build/types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
diff --git a/packages/vue/.npmignore b/packages/vue/.npmignore
@@ -1,5 +1,4 @@
 *
 !/dist/**/*
-!/build/**/*
 !/esm/**/*
-*.tsbuildinfo
+!/build/**/*
diff --git a/packages/vue/package.json b/packages/vue/package.json
@@ -11,7 +11,7 @@
   },
   "main": "dist/index.js",
   "module": "esm/index.js",
-  "types": "dist/index.d.ts",
+  "types": "build/types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
diff --git a/packages/wasm/.npmignore b/packages/wasm/.npmignore
@@ -1,6 +1,4 @@
 *
-!*.js.map
-!*.d.ts
-!*.js
+!/dist/**/*
 !/esm/**/*
-jest.config.js
+!/build/types/**/*
diff --git a/packages/wasm/package.json b/packages/wasm/package.json
@@ -11,7 +11,7 @@
   },
   "main": "dist/index.js",
   "module": "esm/index.js",
-  "types": "dist/index.d.ts",
+  "types": "build/types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
diff --git a/scripts/postbuild.sh b/scripts/postbuild.sh
@@ -9,7 +9,8 @@ BUILD_DIR=build
 
 ASSETS="README.md
 LICENSE
-package.json"
+package.json
+.npmignore"
 
 # check if build dir exists
 if [ ! -d $BUILD_DIR ]; then

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`*`
`2`	`2`	`!/dist/*/`
`3`	`3`	`!/esm/*/`
`4`		`-*.tsbuildinfo`
	`4`	`+!/build/types/*/`