ref(build): introduce central build directory to packages with bundles

in this commit:
* move browser npm build files to `build/npm`
* adjust `postbuild.ts` for tmp copying of bundles into npm

Author: Lms24

.size-limit.js

@@ -25,14 +25,14 @@ module.exports = [
   },
   {
     name: '@sentry/browser - Webpack (gzipped + minified)',
-    path: 'packages/browser/build/esm/index.js',
+    path: 'packages/browser/build/npm/esm/index.js',
     import: '{ init }',
     gzip: true,
     limit: '100 KB',
   },
   {
     name: '@sentry/browser - Webpack (minified)',
-    path: 'packages/browser/build/esm/index.js',
+    path: 'packages/browser/build/npm/esm/index.js',
     import: '{ init }',
     gzip: false,
     limit: '100 KB',

packages/browser/.npmignore

@@ -4,8 +4,8 @@
 
 *
 
-# TODO remove bundles in v7
-!/bundles/**/*
+# TODO remove bundles (which in the tarball are inside `build`) in v7
+!/build/**/*
 
 !/dist/**/*
 !/types/**/*

packages/browser/package.json

@@ -9,9 +9,9 @@
   "engines": {
     "node": ">=6"
   },
-  "main": "build/dist/index.js",
-  "module": "build/esm/index.js",
-  "types": "build/types/index.d.ts",
+  "main": "build/npm/dist/index.js",
+  "module": "build/npm/esm/index.js",
+  "types": "build/npm/types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
@@ -58,7 +58,7 @@
     "build:dev:watch": "run-p build:cjs:watch build:esm:watch build:types:watch",
     "build:esm:watch": "tsc -p tsconfig.esm.json --watch",
     "build:types:watch": "tsc -p tsconfig.types.json --watch",
-    "build:npm": "npm pack ./build",
+    "build:npm": "npm pack ./build/npm",
     "circularDepCheck": "madge --circular src/index.ts",
     "clean": "rimraf build coverage .rpt2_cache",
     "fix": "run-s fix:eslint fix:prettier",

packages/browser/test/package/test-code.js

@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
-const Sentry = require('../../build/dist/index.js');
-const Integrations = require('../../../integrations/dist/dedupe.js');
+const Sentry = require('../../build/npm/dist/index.js');
+const Integrations = require('../../../integrations/build/npm/dist/dedupe.js');
 
 // Init
 Sentry.init({

packages/browser/tsconfig.cjs.json

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

packages/browser/tsconfig.esm.json

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

packages/browser/tsconfig.types.json

@@ -5,6 +5,6 @@
     "declaration": true,
     "declarationMap": true,
     "emitDeclarationOnly": true,
-    "outDir": "build/types"
+    "outDir": "build/npm/types"
   }
 }

packages/integration-tests/utils/generatePlugin.ts

@@ -17,8 +17,8 @@ const useBundle = bundleKey && !useCompiledModule;
 
 const BUNDLE_PATHS: Record<string, Record<string, string>> = {
   browser: {
-    cjs: 'build/dist/index.js',
-    esm: 'build/esm/index.js',
+    cjs: 'build/npm/dist/index.js',
+    esm: 'build/npm/esm/index.js',
     bundle_es5: 'build/bundles/bundle.js',
     bundle_es5_min: 'build/bundles/bundle.min.js',
     bundle_es6: 'build/bundles/bundle.es6.js',

scripts/postbuild.ts

@@ -6,22 +6,22 @@
 */
 
 import * as fs from 'fs';
-
+import * as fse from 'fs-extra';
 import * as path from 'path';
 
-const BUILD_DIR = 'build';
+const NPM_BUILD_DIR = 'build/npm';
 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`);
+  if (!fs.existsSync(path.resolve(NPM_BUILD_DIR))) {
+    console.error(`Directory ${NPM_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}`);
+  console.error(`Error while looking up directory ${NPM_BUILD_DIR}`);
 }
 
 // copy non-code assets to build dir
@@ -32,24 +32,40 @@ ASSETS.forEach(asset => {
       console.error(`Asset ${asset} does not exist.`);
       process.exit(1);
     }
-    fs.copyFileSync(assetPath, path.resolve(BUILD_DIR, asset));
+    fs.copyFileSync(assetPath, path.resolve(NPM_BUILD_DIR, asset));
   } catch (error) {
-    console.error(`Error while copying ${asset} to ${BUILD_DIR}`);
+    console.error(`Error while copying ${asset} to ${NPM_BUILD_DIR}`);
   }
 });
 
+// TODO remove in v7! Until then:
+// copy CDN bundles into npm dir to temporarily keep bundles in npm tarball
+// inside the tarball, they are located in `build/`
+const npmTmpBundlesPath = path.resolve(NPM_BUILD_DIR, 'build');
+const cdnBundlesPaht = path.resolve('build', 'bundles');
+try {
+  if (!fs.existsSync(npmTmpBundlesPath)) {
+    fs.mkdirSync(npmTmpBundlesPath);
+  }
+  fse.copy(cdnBundlesPaht, npmTmpBundlesPath);
+} catch (error) {
+  console.error(`Error while tmp copying CDN bundles to ${NPM_BUILD_DIR}`);
+}
+// end remove
+
 // package.json modifications
-const packageJsonPath = path.resolve(BUILD_DIR, 'package.json');
+const packageJsonPath = path.resolve(NPM_BUILD_DIR, 'package.json');
 const pkgJson: { [key: string]: string } = 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].replace(`${BUILD_DIR}/`, '');
+  pkgJson[entryPoint] = pkgJson[entryPoint].replace(`${NPM_BUILD_DIR}/`, '');
 });
 
 // TODO decide if we want this:
 delete pkgJson.scripts;
 delete pkgJson.volta;
+delete pkgJson.jest;
 
 // write modified package.json to file (pretty-printed with 2 spaces)
 try {