ref(build): Add central build directory to packages without CDN bundles (Part 1) (#4854)

This PR is part 1 of adding the `build` directory to packages _without_ CDN bundles. It is split into two parts to make reviewing easier. It covers the following packages:

* Core
* Gatsby
* Hub
* Minimal

Additionally, it adjusts `prepack.ts` to handle both kinds of packages (with/without CDN bundles) via a CL argument. For the Gatsby SDK, additional actions have to be performed which are only relevant for this package. Therefore, `prepack.ts` now supports calling a package-specific `prepack.ts` file located in `<package>/scripts/prepack.ts`. 

While the tarball structure is identical to the structure in #4838 (except for temporary CDN bundles), the `build` directory structure is simplified due to the fact that there are no CDN bundles or legacy NPM packages to be added to it. Therefore we can reduce one hierarchy level, resulting in the following structure:

```
<sdk>/
├─ build/
│  ├─ cjs/    // dist until v7
│  │  ├─ CJS modules (+maps)
│  ├─ esm/
│  │  ├─ ES6 modules (+maps)
│  ├─ types/
│  │  ├─ *.d.ts files (+maps)
│  ├─ package.json
│  ├─ LICENSE
│  ├─ README.md
├─ ...
```

Co-authored-by: Abhijeet Prasad <[email protected]>

Author: Lms24

packages/core/.npmignore

@@ -1,4 +1,9 @@
+# Info: the paths in this file are specified so that they align with the file
+# structure in `./build` where this file is copied to. This is done by the
+# prepack script `sentry-javascript/scripts/prepack.ts`.
+
 *
+
 !/dist/**/*
 !/esm/**/*
-!/build/types/**/*
+!/types/**/*

packages/core/package.json

@@ -9,8 +9,8 @@
   "engines": {
     "node": ">=6"
   },
-  "main": "dist/index.js",
-  "module": "esm/index.js",
+  "main": "build/dist/index.js",
+  "module": "build/esm/index.js",
   "types": "build/types/index.d.ts",
   "publishConfig": {
     "access": "public"
@@ -35,9 +35,9 @@
     "build:es5:watch": "yarn build:cjs:watch # *** backwards compatibility - remove in v7 ***",
     "build:esm:watch": "tsc -p tsconfig.esm.json --watch",
     "build:types:watch": "tsc -p tsconfig.types.json --watch",
-    "build:npm": "npm pack",
+    "build:npm": "ts-node ../../scripts/prepack.ts -noBundles && npm pack ./build",
     "circularDepCheck": "madge --circular src/index.ts",
-    "clean": "rimraf dist esm coverage",
+    "clean": "rimraf dist esm build coverage",
     "fix": "run-s fix:eslint fix:prettier",
     "fix:eslint": "eslint . --format stylish --fix",
     "fix:prettier": "prettier --write \"{src,test,scripts}/**/*.ts\"",

packages/core/tsconfig.cjs.json

@@ -3,6 +3,6 @@
 
   "compilerOptions": {
     "module": "commonjs",
-    "outDir": "dist"
+    "outDir": "build/dist"
   }
 }

packages/core/tsconfig.esm.json

@@ -3,6 +3,6 @@
 
   "compilerOptions": {
     "module": "es6",
-    "outDir": "esm"
+    "outDir": "build/esm"
   }
 }

packages/gatsby/.eslintrc.js

@@ -6,5 +6,8 @@ module.exports = {
   parserOptions: {
     jsx: true,
   },
+  // ignoring the package-specific prepack script here b/c it is not
+  // covered by a `tsconfig` which makes eslint throw an error
+  ignorePatterns: ['scripts/prepack.ts'],
   extends: ['../../.eslintrc.js'],
 };

packages/gatsby/.npmignore

@@ -1,6 +1,13 @@
+# Info: the paths in this file are specified so that they align with the file
+# structure in `./build` where this file is copied to. This is done by the
+# prepack script `sentry-javascript/scripts/prepack.ts`.
+
 *
+
 !/dist/**/*
 !/esm/**/*
-!/build/types/**/*
+!/types/**/*
+
+# Gatsby specific
 !gatsby-browser.js
 !gatsby-node.js

packages/gatsby/package.json

@@ -13,8 +13,8 @@
   "engines": {
     "node": ">=6"
   },
-  "main": "dist/index.js",
-  "module": "esm/index.js",
+  "main": "build/dist/index.js",
+  "module": "build/esm/index.js",
   "types": "build/types/index.d.ts",
   "publishConfig": {
     "access": "public"
@@ -46,7 +46,7 @@
     "build:es5:watch": "yarn build:cjs:watch # *** backwards compatibility - remove in v7 ***",
     "build:esm:watch": "tsc -p tsconfig.esm.json --watch",
     "build:types:watch": "tsc -p tsconfig.types.json --watch",
-    "build:npm": "npm pack",
+    "build:npm": "ts-node ../../scripts/prepack.ts -noBundles && npm pack ./build",
     "circularDepCheck": "madge --circular src/index.ts",
     "clean": "rimraf dist esm build coverage",
     "fix": "run-s fix:eslint fix:prettier",

packages/gatsby/scripts/prepack.ts

@@ -0,0 +1,27 @@
+/* eslint-disable no-console */
+
+// DO NOT RUN this script yourself!
+// This is invoked from the main `prepack.ts` script in `sentry-javascript/scripts/prepack.ts`.
+
+import * as fs from 'fs';
+import * as path from 'path';
+
+const PACKAGE_ASSETS = ['gatsby-browser.js', 'gatsby-node.js'];
+
+export function prepack(buildDir: string): boolean {
+  // copy package-specific assets to build dir
+  return PACKAGE_ASSETS.every(asset => {
+    const assetPath = path.resolve(asset);
+    try {
+      if (!fs.existsSync(assetPath)) {
+        console.error(`Asset ${asset} does not exist.`);
+        return false;
+      }
+      fs.copyFileSync(assetPath, path.resolve(buildDir, asset));
+    } catch (error) {
+      console.error(`Error while copying ${asset} to ${buildDir}`);
+      return false;
+    }
+    return true;
+  });
+}

packages/gatsby/tsconfig.cjs.json

@@ -3,6 +3,6 @@
 
   "compilerOptions": {
     "module": "commonjs",
-    "outDir": "dist"
+    "outDir": "build/dist"
   }
 }

packages/gatsby/tsconfig.esm.json

@@ -3,6 +3,6 @@
 
   "compilerOptions": {
     "module": "es6",
-    "outDir": "esm"
+    "outDir": "build/esm"
   }
 }