feat(config/jest): add debug information available via DEBUG=hover:jest:*

Author: jrolfs

package.json

@@ -66,6 +66,7 @@
     "cosmiconfig": "^8.3.6",
     "cross-env": "^7.0.3",
     "cross-spawn": "^7.0.3",
+    "debug": "^4.4.0",
     "doctoc": "^2.2.1",
     "eslint": "^8.57.1",
     "eslint-config-airbnb": "19.0.4",
@@ -134,6 +135,7 @@
     "@babel/preset-env": "^7.26.0",
     "@babel/preset-typescript": "^7.23.3",
     "@types/cross-spawn": "^6.0.6",
+    "@types/debug": "^4",
     "depcheck": "^1.4.7",
     "eslint-config-kentcdodds": "^20.5.0",
     "husky": "^8.0.3",

src/config/jest.config.js

@@ -7,14 +7,17 @@ const {
   readDefaultTsConfig,
   tsCompilerOptionsToSwcConfig,
 } = require('@swc-node/register/read-default-tsconfig')
-const {ifAnyDep, hasFile, fromRoot, hasDevDep} = require('../utils')
+
+const {ifAnyDep, hasFile, fromRoot, hasDevDep, getDebug} = require('../utils')
 
 const {
   testMatch,
   testMatchGlob,
   testMatchExtensions,
 } = require('./helpers/test-match')
 
+const debug = getDebug('jest')
+
 const ignores = [
   '/node_modules/',
   '/__fixtures__/',
@@ -24,12 +27,48 @@ const ignores = [
   '__mocks__',
 ]
 
+/**
+ * @type {SwcNodeOptions}
+ */
+const DEFAULT_SWC_OPTIONS = {
+  esModuleInterop: true,
+  module: 'commonjs',
+  react: {runtime: 'automatic'},
+  swc: {
+    jsc: {
+      target: 'es2020',
+      experimental: {
+        plugins: [[require.resolve('swc_mut_cjs_exports'), {}]],
+      },
+      parser: {
+        syntax: 'typescript',
+        tsx: true,
+        decorators: false,
+        dynamicimport: true,
+      },
+      loose: true,
+      externalHelpers: false,
+      transform: {
+        react: {
+          runtime: 'automatic',
+        },
+      },
+    },
+  },
+}
+
+const tsConfig = readDefaultTsConfig()
+const swcConfig = merge(
+  tsCompilerOptionsToSwcConfig(tsConfig, ''),
+  DEFAULT_SWC_OPTIONS,
+)
+
+debug.prefix('tsconfig:paths')(tsConfig.paths)
+
 /**
  * Get the path at which `@hover/javascript/jest` is installed in a dependent
  * project in order to resolve the Jest preset as sometimes package managers
  * nest the preset installation within the `@hover/javascript` installation.
- * 
- * @returns 
  */
 const getResolvePaths = () => {
   try {
@@ -41,6 +80,54 @@ const getResolvePaths = () => {
   }
 }
 
+/**
+ * The default transform is now SWC, however, `ts-jest` will
+ * still be used if it is installed in the host project
+ *
+ * @returns {JestConfig['transform']}
+ */
+const getTransform = () => {
+  const log = debug.prefix('transform')
+
+  if (hasDevDep('ts-jest')) {
+    log('Detected `ts-jest` package, using ts-jest transform')
+
+    const transform = Object.fromEntries(
+      // Ensure we can resolve the preset even when
+      // it's in a nested `node_modules` installation
+      Object.entries(require('ts-jest/presets').jsWithTs.transform).map(
+        ([glob, [transformer, options]]) => [
+          glob,
+          [
+            require.resolve(transformer),
+            {
+              ...options,
+              diagnostics: false,
+            },
+          ],
+        ],
+      ),
+    )
+
+    log(transform)
+
+    return transform
+  }
+
+  log('No `ts-jest` package detected, using default SWC transform')
+
+  const transform = {
+    '^.+\\.(t|j|mj)sx?$': [
+      require.resolve('@swc-node/jest', getResolvePaths()),
+      swcConfig,
+    ],
+  }
+
+  log(transform)
+
+  return transform
+}
+
 /** @type JestConfig */
 const jestConfig = {
   roots: [fromRoot('.')],
@@ -55,52 +142,7 @@ const jestConfig = {
   testMatch,
   testPathIgnorePatterns: [...ignores, '<rootDir>/dist'],
   testLocationInResults: true,
-  // The default transform is now SWC, however, `ts-jest` will
-  // still be used if it is installed in the host project
-  transform: hasDevDep('ts-jest')
-    ? Object.fromEntries(
-        // Ensure we can resolve the preset even when
-        // it's in a nested `node_modules` installation
-        Object.entries(require('ts-jest/presets').jsWithTs.transform).map(
-          ([glob, [transformer, options]]) => [
-            glob,
-            [
-              require.resolve(transformer),
-              {
-                ...options,
-                diagnostics: false,
-              },
-            ],
-          ],
-        ),
-      )
-    : {
-        '^.+\\.(t|j)sx?$': [
-          require.resolve('@swc-node/jest', getResolvePaths()),
-          /** @type {SwcNodeOptions} */ (
-            merge(tsCompilerOptionsToSwcConfig(readDefaultTsConfig(), ''), {
-              esModuleInterop: true,
-              module: 'commonjs',
-              swc: {
-                jsc: {
-                  target: 'es2020',
-                  experimental: {
-                    plugins: [[require.resolve('swc_mut_cjs_exports'), {}]],
-                  },
-                  parser: {
-                    syntax: 'typescript',
-                    tsx: true,
-                    decorators: false,
-                    dynamicimport: true,
-                  },
-                  loose: true,
-                  externalHelpers: false,
-                },
-              },
-            })
-          ),
-        ],
-      },
+  transform: getTransform(),
   coveragePathIgnorePatterns: [
     ...ignores,
     'src/(umd|cjs|esm)-entry.js$',

src/utils.js

@@ -1,3 +1,4 @@
+const debug = require('debug')
 const fs = require('fs')
 const path = require('path')
 const rimraf = require('rimraf')
@@ -266,10 +267,49 @@ const relative =
   p =>
     path.join(dirname, p).replace(process.cwd(), '.')
 
+const DEBUG_NAMESPACE = 'hover'
+
+/**
+ * Get debug output functions prefixed for the provided namespace.
+ *
+ * @param {string} namespace
+ */
+const getDebug = namespace => {
+  /**
+   * @param {string} [prefix]
+   */
+  const debugForNamespace = prefix =>
+    debug([DEBUG_NAMESPACE, namespace, prefix].filter(Boolean).join(':'))
+
+  return Object.assign(debugForNamespace(), {
+    /**
+     * Output and return an an expression for debugging.
+     *
+     * @template T
+     *
+     * @param {T} output
+     * @param {string} [prefix] Optional prefix to append to debug namespace
+     *
+     * @returns {T}
+     */
+    trace: (output, prefix) => {
+      debugForNamespace(prefix)(output)
+      return output
+    },
+    /**
+     * Get a debug function with an additional prefix appended to namespace.
+     *
+     * @param {string} prefix
+     */
+    prefix: prefix => debugForNamespace(prefix),
+  })
+}
+
 module.exports = {
   appDirectory,
   fromRoot,
   getConcurrentlyArgs,
+  getDebug,
   getPkgName,
   hasAnyDep,
   hasDevDep,

yarn.lock

@@ -2279,6 +2279,7 @@ __metadata:
     "@swc/core": ^1.3.102
     "@swc/helpers": ^0.5.3
     "@types/cross-spawn": ^6.0.6
+    "@types/debug": ^4
     "@types/jest": ^29.5.4
     "@types/lodash.has": ^4.5.9
     "@types/mkdirp": ^1.0.2
@@ -2292,6 +2293,7 @@ __metadata:
     cosmiconfig: ^8.3.6
     cross-env: ^7.0.3
     cross-spawn: ^7.0.3
+    debug: ^4.4.0
     depcheck: ^1.4.7
     doctoc: ^2.2.1
     eslint: ^8.57.1
@@ -3311,6 +3313,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/debug@npm:^4":
+  version: 4.1.12
+  resolution: "@types/debug@npm:4.1.12"
+  dependencies:
+    "@types/ms": "*"
+  checksum: 47876a852de8240bfdaf7481357af2b88cb660d30c72e73789abf00c499d6bc7cd5e52f41c915d1b9cd8ec9fef5b05688d7b7aef17f7f272c2d04679508d1053
+  languageName: node
+  linkType: hard
+
 "@types/glob@npm:*":
   version: 7.2.0
   resolution: "@types/glob@npm:7.2.0"
@@ -3438,6 +3449,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/ms@npm:*":
+  version: 2.1.0
+  resolution: "@types/ms@npm:2.1.0"
+  checksum: 532d2ebb91937ccc4a89389715e5b47d4c66e708d15942fe6cc25add6dc37b2be058230a327dd50f43f89b8b6d5d52b74685a9e8f70516edfc9bdd6be910eff4
+  languageName: node
+  linkType: hard
+
 "@types/node@npm:*":
   version: 18.11.18
   resolution: "@types/node@npm:18.11.18"
@@ -5500,6 +5518,18 @@ __metadata:
   languageName: node
   linkType: hard
 
+"debug@npm:^4.4.0":
+  version: 4.4.0
+  resolution: "debug@npm:4.4.0"
+  dependencies:
+    ms: ^2.1.3
+  peerDependenciesMeta:
+    supports-color:
+      optional: true
+  checksum: fb42df878dd0e22816fc56e1fdca9da73caa85212fbe40c868b1295a6878f9101ae684f4eeef516c13acfc700f5ea07f1136954f43d4cd2d477a811144136479
+  languageName: node
+  linkType: hard
+
 "decamelize-keys@npm:^1.1.0":
   version: 1.1.0
   resolution: "decamelize-keys@npm:1.1.0"