ref(build): Convert postbuild.sh to node script (#4828)

Replace the bash script `postbuild.sh` with the node script `postbuild.ts` which can be run with `ts-node`. This is done to conform with our decision to change all bash scripts to node s.t. they can be run on any platform (incl. Windows). Furthermore, it gives us the flexibility to add additional functionality in the future that is harder to code/read in bash.

Co-authored-by: Katie Byers <[email protected]>

Author: Lms24

packages/browser/.npmignore

@@ -1,6 +1,6 @@
-# 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
+# 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
+# postbuild script `sentry-javascript/scripts/postbuild.ts`.
 
 *
 

packages/browser/package.json

@@ -44,7 +44,7 @@
     "webpack": "^4.30.0"
   },
   "scripts": {
-    "build": "run-p build:cjs build:esm build:bundle build:types && bash ../../scripts/postbuild.sh",
+    "build": "run-p build:cjs build:esm build:bundle build:types && ts-node ../../scripts/postbuild.ts",
     "build:bundle": "rollup --config",
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "build:dev": "run-p build:cjs build:esm build:types",

scripts/postbuild.sh

@@ -0,0 +1,63 @@
+/*
+  This script prepares the central `build` directory for NPM package creation.
+  It first copies all non-code files into the `build` directory, including `package.json`, which
+  is edited to adjust entry point paths. These corrections are performed so that the paths align with
+  the directory structure inside `build`.
+*/
+
+import * as fs from 'fs';
+
+import * as path from 'path';
+
+const BUILD_DIR = 'build';
+const ASSETS = ['README.md', 'LICENSE', 'package.json', '.npmignore'];
+const ENTRY_POINTS = ['main', 'module', 'types'];
+
+// check if build dir exists
+try {
+  if (!fs.existsSync(path.resolve(BUILD_DIR))) {
+    console.error(`Directory ${BUILD_DIR} DOES NOT exist`);
+    console.error("This script should only be executed after you've run `yarn build`.");
+    process.exit(1);
+  }
+} catch (error) {
+  console.error(`Error while looking up directory ${BUILD_DIR}`);
+  process.exit(1);
+}
+
+// copy non-code assets to build dir
+ASSETS.forEach(asset => {
+  const assetPath = path.resolve(asset);
+  try {
+    if (!fs.existsSync(assetPath)) {
+      console.error(`Asset ${asset} does not exist.`);
+      process.exit(1);
+    }
+    fs.copyFileSync(assetPath, path.resolve(BUILD_DIR, asset));
+  } catch (error) {
+    console.error(`Error while copying ${asset} to ${BUILD_DIR}`);
+    process.exit(1);
+  }
+});
+
+// package.json modifications
+const packageJsonPath = path.resolve(BUILD_DIR, 'package.json');
+const pkgJson: { [key: string]: unknown } = require(packageJsonPath);
+
+// modify entry points to point to correct paths (i.e. strip out the build directory)
+ENTRY_POINTS.filter(entryPoint => pkgJson[entryPoint]).forEach(entryPoint => {
+  pkgJson[entryPoint] = (pkgJson[entryPoint] as string).replace(`${BUILD_DIR}/`, '');
+});
+
+delete pkgJson.scripts;
+delete pkgJson.volta;
+
+// write modified package.json to file (pretty-printed with 2 spaces)
+try {
+  fs.writeFileSync(packageJsonPath, JSON.stringify(pkgJson, null, 2));
+} catch (error) {
+  console.error(`Error while writing package.json to disk`);
+  process.exit(1);
+}
+
+console.log(`\nSuccessfully finished postbuild commands for ${pkgJson.name}`);