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

Author: Lms24

.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'],

.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

.gitignore

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

.npmignore

@@ -3,6 +3,6 @@
 
 *
 
-!/dist/**/*
+!/cjs/**/*
 !/esm/**/*
 !/types/**/*

.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"
-
-    },
+    }
   ]
 }

packages/angular/.npmignore

@@ -1,4 +1,4 @@
 *
-!/dist/**/*
+!/cjs/**/*
 !/esm/**/*
 !/build/types/**/*

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\"",

packages/angular/tsconfig.cjs.json

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

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": {

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({