ref(build): Rename dist directories to cjs (#4900)

rename the dist directories in all build dirs to cjs. Hence, also the tarballs' structure changes which is why this PR also introduces a breaking change. Additional change: cleanup `yarn clean` commands by removing no longer existing directories
getsentry · Apr 26, 2022 · d9936eb · d9936eb
1 parent 42a11c8
commit d9936eb
Show file tree

Hide file tree

Showing 59 changed files with 104 additions and 106 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -10,7 +10,16 @@ module.exports = {
     ecmaVersion: 2018,
   },
   extends: ['@sentry-internal/sdk'],
-  ignorePatterns: ['coverage/**', 'build/**', 'dist/**', 'esm/**', 'examples/**', 'test/manual/**', 'types/**'],
+  ignorePatterns: [
+    'coverage/**',
+    'build/**',
+    'dist/**',
+    'cjs/**',
+    'esm/**',
+    'examples/**',
+    'test/manual/**',
+    'types/**',
+  ],
   overrides: [
     {
       files: ['*.ts', '*.tsx', '*.d.ts'],

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -23,7 +23,7 @@ env:
 
   CACHED_BUILD_PATHS: |
     ${{ github.workspace }}/packages/**/build
-    ${{ github.workspace }}/packages/**/dist
+    ${{ github.workspace }}/packages/**/cjs
     ${{ github.workspace }}/packages/**/esm
     ${{ github.workspace }}/packages/ember/*.d.ts
     ${{ github.workspace }}/packages/ember/instance-initializers

diff --git a/.gitignore b/.gitignore
@@ -5,7 +5,7 @@ package-lock.json
 
 # build and test
 build/
-packages/*/dist/
+packages/*/cjs/
 packages/*/esm/
 coverage/
 scratch/

diff --git a/.npmignore b/.npmignore
@@ -3,6 +3,6 @@
 
 *
 
-!/dist/**/*
+!/cjs/**/*
 !/esm/**/*
 !/types/**/*
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -5,16 +5,16 @@
   "version": "0.2.0",
   "inputs": [
     {
-        "id": "getPackageName",
-        "type": "command",
-        "command": "shellCommand.execute",
-        "args": {
-            "command": "echo '${file}' | sed s/'.*sentry-javascript\\/packages\\/'// | grep --extended-regexp --only-matching --max-count 1 '[^\\/]+' | head -1",
-            "cwd": "${workspaceFolder}" ,
-            // normally `input` commands bring up a selector for the user, but given that there should only be one
-            // choice here, this lets us skip the prompt
-            "useSingleResult": true
-        }
+      "id": "getPackageName",
+      "type": "command",
+      "command": "shellCommand.execute",
+      "args": {
+        "command": "echo '${file}' | sed s/'.*sentry-javascript\\/packages\\/'// | grep --extended-regexp --only-matching --max-count 1 '[^\\/]+' | head -1",
+        "cwd": "${workspaceFolder}",
+        // normally `input` commands bring up a selector for the user, but given that there should only be one
+        // choice here, this lets us skip the prompt
+        "useSingleResult": true
+      }
     }
   ],
   "configurations": [
@@ -25,18 +25,9 @@
       "cwd": "${workspaceFolder}/packages/${input:getPackageName}",
       "request": "launch",
       "runtimeExecutable": "yarn",
-      "runtimeArgs": [
-        "rollup",
-        "-c",
-        "${file}"
-      ],
-      "skipFiles": [
-        "<node_internals>/**"
-      ],
-      "outFiles": [
-        "${workspaceFolder}/**/*.js",
-        "!**/node_modules/**"
-      ],
+      "runtimeArgs": ["rollup", "-c", "${file}"],
+      "skipFiles": ["<node_internals>/**"],
+      "outFiles": ["${workspaceFolder}/**/*.js", "!**/node_modules/**"],
       "sourceMaps": true,
       "smartStep": true,
       "internalConsoleOptions": "openOnSessionStart",
@@ -67,14 +58,13 @@
       ],
       "sourceMaps": true,
       "smartStep": true,
-       // otherwise it goes to the VSCode debug terminal, which prints the test output or console logs (depending on
-       // "outputCapture" option here; default is to show console logs), but not both
+      // otherwise it goes to the VSCode debug terminal, which prints the test output or console logs (depending on
+      // "outputCapture" option here; default is to show console logs), but not both
       "console": "integratedTerminal",
       // since we're not using it, don't automatically switch to it
-      "internalConsoleOptions": "neverOpen",
+      "internalConsoleOptions": "neverOpen"
     },
 
-
     // @sentry/nextjs - Run a specific integration test file
     // Must have test file in currently active tab when hitting the play button, and must already have run `yarn` in test app directory
     {
@@ -105,18 +95,17 @@
       // this controls which files are sourcemapped
       "outFiles": [
         // our SDK code
-        "${workspaceFolder}/**/dist/**/*.js",
+        "${workspaceFolder}/**/cjs/**/*.js",
         // the built test app
         "${workspaceFolder}/packages/nextjs/test/integration/.next/**/*.js",
         "!**/node_modules/**"
       ],
       "resolveSourceMapLocations": [
-        "${workspaceFolder}/**/dist/**",
+        "${workspaceFolder}/**/cjs/**",
         "${workspaceFolder}/packages/nextjs/test/integration/.next/**",
         "!**/node_modules/**"
       ],
       "internalConsoleOptions": "openOnSessionStart"
-
-    },
+    }
   ]
 }
diff --git a/packages/angular/.npmignore b/packages/angular/.npmignore
@@ -1,4 +1,4 @@
 *
-!/dist/**/*
+!/cjs/**/*
 !/esm/**/*
 !/build/types/**/*
diff --git a/packages/angular/package.json b/packages/angular/package.json
@@ -9,7 +9,7 @@
   "engines": {
     "node": ">=8"
   },
-  "main": "dist/index.js",
+  "main": "cjs/index.js",
   "module": "esm/index.js",
   "types": "build/types/index.d.ts",
   "publishConfig": {
@@ -47,7 +47,7 @@
     "build:types:watch": "tsc -p tsconfig.types.json --watch",
     "build:npm": "npm pack",
     "circularDepCheck": "madge --circular src/index.ts",
-    "clean": "rimraf dist esm build coverage",
+    "clean": "rimraf cjs esm build coverage",
     "fix": "run-s fix:eslint fix:prettier",
     "fix:eslint": "eslint . --format stylish --fix",
     "fix:prettier": "prettier --write \"{src,test,scripts}/**/*.ts\"",

diff --git a/packages/angular/tsconfig.cjs.json b/packages/angular/tsconfig.cjs.json
@@ -3,6 +3,6 @@
 
   "compilerOptions": {
     "module": "commonjs",
-    "outDir": "dist"
+    "outDir": "cjs"
   }
 }
diff --git a/packages/browser/package.json b/packages/browser/package.json
@@ -9,7 +9,7 @@
   "engines": {
     "node": ">=8"
   },
-  "main": "build/npm/dist/index.js",
+  "main": "build/npm/cjs/index.js",
   "module": "build/npm/esm/index.js",
   "types": "build/npm/types/index.d.ts",
   "publishConfig": {

diff --git a/packages/browser/test/package/test-code.js b/packages/browser/test/package/test-code.js
@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
-const Sentry = require('../../build/npm/dist/index.js');
-const Integrations = require('../../../integrations/build/npm/dist/dedupe.js');
+const Sentry = require('../../build/npm/cjs/index.js');
+const Integrations = require('../../../integrations/build/npm/cjs/dedupe.js');
 
 // Init
 Sentry.init({

diff --git a/packages/browser/tsconfig.cjs.json b/packages/browser/tsconfig.cjs.json
@@ -3,6 +3,6 @@
 
   "compilerOptions": {
     "module": "commonjs",
-    "outDir": "build/npm/dist"
+    "outDir": "build/npm/cjs"
   }
 }
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -9,7 +9,7 @@
   "engines": {
     "node": ">=8"
   },
-  "main": "build/dist/index.js",
+  "main": "build/cjs/index.js",
   "module": "build/esm/index.js",
   "types": "build/types/index.d.ts",
   "publishConfig": {
@@ -37,7 +37,7 @@
     "build:types:watch": "tsc -p tsconfig.types.json --watch",
     "build:npm": "ts-node ../../scripts/prepack.ts && npm pack ./build",
     "circularDepCheck": "madge --circular src/index.ts",
-    "clean": "rimraf dist esm build coverage",
+    "clean": "rimraf build coverage",
     "fix": "run-s fix:eslint fix:prettier",
     "fix:eslint": "eslint . --format stylish --fix",
     "fix:prettier": "prettier --write \"{src,test,scripts}/**/*.ts\"",

diff --git a/packages/core/tsconfig.cjs.json b/packages/core/tsconfig.cjs.json
@@ -3,6 +3,6 @@
 
   "compilerOptions": {
     "module": "commonjs",
-    "outDir": "build/dist"
+    "outDir": "build/cjs"
   }
 }
diff --git a/packages/gatsby/.npmignore b/packages/gatsby/.npmignore
@@ -3,7 +3,7 @@
 
 *
 
-!/dist/**/*
+!/cjs/**/*
 !/esm/**/*
 !/types/**/*
 

diff --git a/packages/gatsby/package.json b/packages/gatsby/package.json
@@ -13,7 +13,7 @@
   "engines": {
     "node": ">=8"
   },
-  "main": "build/dist/index.js",
+  "main": "build/cjs/index.js",
   "module": "build/esm/index.js",
   "types": "build/types/index.d.ts",
   "publishConfig": {
@@ -48,7 +48,7 @@
     "build:types:watch": "tsc -p tsconfig.types.json --watch",
     "build:npm": "ts-node ../../scripts/prepack.ts && npm pack ./build",
     "circularDepCheck": "madge --circular src/index.ts",
-    "clean": "rimraf dist esm build coverage",
+    "clean": "rimraf build coverage",
     "fix": "run-s fix:eslint fix:prettier",
     "fix:eslint": "eslint . --format stylish --fix",
     "fix:prettier": "prettier --write \"{src,test,scripts}/**/*.ts\"",

diff --git a/packages/gatsby/tsconfig.cjs.json b/packages/gatsby/tsconfig.cjs.json
@@ -3,6 +3,6 @@
 
   "compilerOptions": {
     "module": "commonjs",
-    "outDir": "build/dist"
+    "outDir": "build/cjs"
   }
 }
diff --git a/packages/hub/package.json b/packages/hub/package.json
@@ -9,7 +9,7 @@
   "engines": {
     "node": ">=8"
   },
-  "main": "build/dist/index.js",
+  "main": "build/cjs/index.js",
   "module": "build/esm/index.js",
   "types": "build/types/index.d.ts",
   "publishConfig": {
@@ -35,7 +35,7 @@
     "build:types:watch": "tsc -p tsconfig.types.json --watch",
     "build:npm": "ts-node ../../scripts/prepack.ts && npm pack ./build",
     "circularDepCheck": "madge --circular src/index.ts",
-    "clean": "rimraf dist esm coverage",
+    "clean": "rimraf build coverage",
     "fix": "run-s fix:eslint fix:prettier",
     "fix:eslint": "eslint . --format stylish --fix",
     "fix:prettier": "prettier --write \"{src,test,scripts}/**/*.ts\"",

diff --git a/packages/hub/tsconfig.cjs.json b/packages/hub/tsconfig.cjs.json
@@ -3,6 +3,6 @@
 
   "compilerOptions": {
     "module": "commonjs",
-    "outDir": "build/dist"
+    "outDir": "build/cjs"
   }
 }
diff --git a/packages/integration-tests/utils/generatePlugin.ts b/packages/integration-tests/utils/generatePlugin.ts
@@ -17,15 +17,15 @@ const useBundle = bundleKey && !useCompiledModule;
 
 const BUNDLE_PATHS: Record<string, Record<string, string>> = {
   browser: {
-    cjs: 'build/npm/dist/index.js',
+    cjs: 'build/npm/cjs/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',
     bundle_es6_min: 'build/bundles/bundle.es6.min.js',
   },
   tracing: {
-    cjs: 'build/npm/dist/index.js',
+    cjs: 'build/npm/cjs/index.js',
     esm: 'build/npm/esm/index.js',
     bundle_es5: 'build/bundles/bundle.tracing.js',
     bundle_es5_min: 'build/bundles/bundle.tracing.min.js',

diff --git a/packages/integrations/package.json b/packages/integrations/package.json
@@ -12,7 +12,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "main": "build/npm/dist/index.js",
+  "main": "build/npm/cjs/index.js",
   "module": "build/npm/esm/index.js",
   "types": "build/npm/types/index.d.ts",
   "dependencies": {
@@ -40,7 +40,7 @@
     "build:types:watch": "tsc -p tsconfig.types.json --watch",
     "build:npm": "ts-node ../../scripts/prepack.ts --bundles && npm pack ./build/npm",
     "circularDepCheck": "madge --circular src/index.ts",
-    "clean": "rimraf dist esm build coverage .rpt2_cache",
+    "clean": "rimraf build coverage .rpt2_cache",
     "fix": "run-s fix:eslint fix:prettier",
     "fix:eslint": "eslint . --format stylish --fix",
     "fix:prettier": "prettier --write \"{src,test,scripts}/**/*.ts\"",

diff --git a/packages/integrations/tsconfig.cjs.json b/packages/integrations/tsconfig.cjs.json
@@ -3,6 +3,6 @@
 
   "compilerOptions": {
     "module": "commonjs",
-    "outDir": "build/npm/dist"
+    "outDir": "build/npm/cjs"
   }
 }
diff --git a/packages/minimal/package.json b/packages/minimal/package.json
@@ -9,7 +9,7 @@
   "engines": {
     "node": ">=8"
   },
-  "main": "build/dist/index.js",
+  "main": "build/cjs/index.js",
   "module": "build/esm/index.js",
   "types": "build/types/index.d.ts",
   "publishConfig": {
@@ -35,7 +35,7 @@
     "build:types:watch": "tsc -p tsconfig.types.json --watch",
     "build:npm": "ts-node ../../scripts/prepack.ts && npm pack ./build",
     "circularDepCheck": "madge --circular src/index.ts",
-    "clean": "rimraf dist esm build coverage",
+    "clean": "rimraf build coverage",
     "fix": "run-s fix:eslint fix:prettier",
     "fix:eslint": "eslint . --format stylish --fix",
     "fix:prettier": "prettier --write \"{src,test,scripts}/**/*.ts\"",

diff --git a/packages/minimal/tsconfig.cjs.json b/packages/minimal/tsconfig.cjs.json
@@ -3,6 +3,6 @@
 
   "compilerOptions": {
     "module": "commonjs",
-    "outDir": "build/dist"
+    "outDir": "build/cjs"
   }
 }
diff --git a/packages/nextjs/package.json b/packages/nextjs/package.json
@@ -9,7 +9,7 @@
   "engines": {
     "node": ">=8"
   },
-  "main": "build/dist/index.server.js",
+  "main": "build/cjs/index.server.js",
   "module": "build/esm/index.server.js",
   "browser": "build/esm/index.client.js",
   "types": "build/types/index.server.d.ts",
@@ -57,7 +57,7 @@
     "build:types:watch": "tsc -p tsconfig.types.json --watch",
     "build:npm": "ts-node ../../scripts/prepack.ts && npm pack ./build",
     "circularDepCheck": "madge --circular src/index.client.ts && madge --circular --exclude 'config/types\\.ts' src/index.server.ts # see https://github.com/pahen/madge/issues/306",
-    "clean": "rimraf dist esm build coverage *.js *.js.map *.d.ts",
+    "clean": "rimraf build coverage *.js *.js.map *.d.ts",
     "fix": "run-s fix:eslint fix:prettier",
     "fix:eslint": "eslint . --format stylish --fix",
     "fix:prettier": "prettier --write \"{src,test,scripts}/**/*.ts\"",
@@ -97,7 +97,7 @@
     }
   },
   "sideEffects": [
-    "./dist/index.server.js",
+    "./cjs/index.server.js",
     "./esm/index.server.js",
     "./src/index.server.ts"
   ]

diff --git a/packages/nextjs/tsconfig.cjs.json b/packages/nextjs/tsconfig.cjs.json
@@ -3,6 +3,6 @@
 
   "compilerOptions": {
     "module": "commonjs",
-    "outDir": "build/dist"
+    "outDir": "build/cjs"
   }
 }
diff --git a/packages/nextjs/vercel/install-sentry-from-branch.sh b/packages/nextjs/vercel/install-sentry-from-branch.sh
@@ -28,7 +28,7 @@ yarn --prod false
 echo " "
 echo "BUILDING SDK"
 # We need to build es5 versions because `next.config.js` calls `require` on the SDK (to get `withSentryConfig`) and
-# therefore it looks for `dist/index.js`
+# therefore it looks for `cjs/index.js`
 yarn build:cjs
 # We need to build esm versions because that's what `next` actually uses when it builds the app
 yarn build:esm