chore(many): make documentation preview builds show console messages

INSTUI-4522

Author: ToMESSKa

.github/workflows/preview.yml

@@ -12,6 +12,8 @@ on:
 jobs:
   deploy-preview:
     runs-on: ubuntu-latest
+    env:
+      GITHUB_PULL_REQUEST_PREVIEW: 'true'
     steps:
       - uses: actions/checkout@v4
       - name: Install Node 22

packages/__docs__/webpack.config.mjs

@@ -30,9 +30,12 @@ import { globbySync } from 'globby'
 import { merge } from 'webpack-merge'
 import { processSingleFile } from './lib/build-docs.mjs'
 import resolve from './resolve.mjs'
+import webpack from 'webpack'
+import TerserPlugin from 'terser-webpack-plugin'
 
 const ENV = process.env.NODE_ENV || 'production'
 const DEBUG = process.env.DEBUG || ENV === 'development'
+const GITHUB_PULL_REQUEST_PREVIEW = process.env.GITHUB_PULL_REQUEST_PREVIEW || 'false'
 
 const outputPath = resolvePath(import.meta.dirname, '__build__')
 const resolveAliases = DEBUG ? { resolve } : {}
@@ -79,6 +82,9 @@ const config = merge(baseConfig, {
       template: './src/index.html',
       chunks: ['main'],
     }),
+    new webpack.DefinePlugin({
+      'process.env.GITHUB_PULL_REQUEST_PREVIEW': JSON.stringify(GITHUB_PULL_REQUEST_PREVIEW),
+    }),
   ],
   optimization: {
     usedExports: true,

packages/canvas-high-contrast-theme/babel.config.js

@@ -29,7 +29,9 @@ module.exports = {
       {
         coverage: Boolean(process.env.COVERAGE),
         esModules: Boolean(process.env.ES_MODULES),
-        removeConsole: process.env.NODE_ENV === 'production',
+        removeConsole:
+          process.env.NODE_ENV === 'production' &&
+          process.env.GITHUB_PULL_REQUEST_PREVIEW !== 'true',
         transformImports: false
       }
     ]

packages/canvas-theme/babel.config.js

@@ -29,7 +29,9 @@ module.exports = {
       {
         coverage: Boolean(process.env.COVERAGE),
         esModules: Boolean(process.env.ES_MODULES),
-        removeConsole: process.env.NODE_ENV === 'production',
+        removeConsole:
+          process.env.NODE_ENV === 'production' &&
+          process.env.GITHUB_PULL_REQUEST_PREVIEW !== 'true',
         transformImports: false
       }
     ]

packages/console/src/console.ts

@@ -55,7 +55,13 @@ function logMessage(
   message: string,
   ...args: unknown[]
 ) {
-  if (process.env.NODE_ENV !== 'production' && !condition) {
+  const isGitHubPullRequestPreview =
+    typeof process !== 'undefined' &&
+    process?.env?.GITHUB_PULL_REQUEST_PREVIEW === 'true'
+  if (
+    (isGitHubPullRequestPreview || process.env.NODE_ENV !== 'production') &&
+    !condition
+  ) {
     if (typeof console[level] === 'function') {
       const renderStack = withRenderStack ? getRenderStack() : ''
       //@ts-expect-error level can be 'constructor' which is not callable

packages/debounce/babel.config.js

@@ -29,7 +29,9 @@ module.exports = {
       {
         coverage: Boolean(process.env.COVERAGE),
         esModules: Boolean(process.env.ES_MODULES),
-        removeConsole: process.env.NODE_ENV === 'production',
+        removeConsole:
+          process.env.NODE_ENV === 'production' &&
+          process.env.GITHUB_PULL_REQUEST_PREVIEW !== 'true',
         transformImports: Boolean(process.env.TRANSFORM_IMPORTS)
       }
     ]

packages/emotion/babel.config.js

@@ -29,7 +29,9 @@ module.exports = {
       {
         coverage: Boolean(process.env.COVERAGE),
         esModules: Boolean(process.env.ES_MODULES),
-        removeConsole: process.env.NODE_ENV === 'production',
+        removeConsole:
+          process.env.NODE_ENV === 'production' &&
+          process.env.GITHUB_PULL_REQUEST_PREVIEW !== 'true',
         transformImports: Boolean(process.env.TRANSFORM_IMPORTS)
       }
     ]

packages/ui-a11y-content/babel.config.js

@@ -29,7 +29,9 @@ module.exports = {
       {
         coverage: Boolean(process.env.COVERAGE),
         esModules: Boolean(process.env.ES_MODULES),
-        removeConsole: process.env.NODE_ENV === 'production',
+        removeConsole:
+          process.env.NODE_ENV === 'production' &&
+          process.env.GITHUB_PULL_REQUEST_PREVIEW !== 'true',
         transformImports: Boolean(process.env.TRANSFORM_IMPORTS)
       }
     ]

packages/ui-a11y-utils/babel.config.js

@@ -29,7 +29,9 @@ module.exports = {
       {
         coverage: Boolean(process.env.COVERAGE),
         esModules: Boolean(process.env.ES_MODULES),
-        removeConsole: process.env.NODE_ENV === 'production',
+        removeConsole:
+          process.env.NODE_ENV === 'production' &&
+          process.env.GITHUB_PULL_REQUEST_PREVIEW !== 'true',
         transformImports: Boolean(process.env.TRANSFORM_IMPORTS)
       }
     ]

packages/ui-alerts/babel.config.js

@@ -29,7 +29,9 @@ module.exports = {
       {
         coverage: Boolean(process.env.COVERAGE),
         esModules: Boolean(process.env.ES_MODULES),
-        removeConsole: process.env.NODE_ENV === 'production',
+        removeConsole:
+          process.env.NODE_ENV === 'production' &&
+          process.env.GITHUB_PULL_REQUEST_PREVIEW !== 'true',
         transformImports: Boolean(process.env.TRANSFORM_IMPORTS)
       }
     ]