add build dir to @sentry/gatsby

Author: Lms24

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,22 @@
+/* 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 BUILD_DIR = 'build';
+const PACKAGE_ASSETS = ['gatsby-browser.js', 'gatsby-node.js'];
+
+// copy package-specific assets to build dir
+PACKAGE_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}`);
+  }
+});

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"
   }
 }

scripts/prepack.ts

@@ -6,6 +6,7 @@
   the directory structure inside `build`.
 */
 
+import * as childProcess from 'child_process';
 import * as fs from 'fs';
 import * as fse from 'fs-extra';
 import * as path from 'path';
@@ -88,4 +89,23 @@ try {
   process.exit(1);
 }
 
+// execute package specific settings
+// 1. check if a package called `<package-root>/scripts/prepack.ts` exitsts
+// if yes, 2.) execute that script for things that are package-specific
+const packagePrepackPath = path.resolve('scripts', 'prepack.ts');
+try {
+  if (fs.existsSync(packagePrepackPath)) {
+    const proc = childProcess.fork(packagePrepackPath);
+    proc.on('exit', code => {
+      if (code !== 0) {
+        console.error(`Error while executing ${packagePrepackPath.toString()}`);
+        process.exit(1);
+      }
+    });
+  }
+} catch (error) {
+  console.error(`Error while trying to access ${packagePrepackPath.toString()}`);
+  process.exit(1);
+}
+
 console.log(`\nSuccessfully finished prepack commands for ${pkgJson.name}\n`);