refactor: create inquirer-pack bundle to eliminate duplication

jdalton · jdalton · commit d382b78a3c60 · 2026-01-07T18:34:59.000-05:00
Consolidates all 6 @InQuirer packages into a single inquirer-pack bundle to eliminate duplicate code across individual packages. Individual @InQuirer modules now re-export from inquirer-pack as thin wrappers (~150 bytes each). Changes: - Add src/external/inquirer-pack.js and .d.ts with all @InQuirer packages - Convert @inquirer/{checkbox,confirm,input,password,search,select}.js to wrappers - Update build-externals config to bundle inquirer-pack and copy wrappers - Update build-externals orchestrator to support bundle:false for scoped packages array - Update validation scripts to allow @InQuirer packages with default-only exports - Update build-externals test to check for inquirer-pack bundle and thin wrappers Bundle size impact: - Before: 594KB total (6 packages × ~99KB average) - After: 183KB inquirer-pack + 6 × ~150B wrappers = ~184KB total - Savings: ~410KB (69% reduction)
diff --git a/.config/tsconfig.external-aliases.json b/.config/tsconfig.external-aliases.json
@@ -12,6 +12,7 @@
       "make-fetch-happen": ["../src/external/make-fetch-happen"],
       "fast-sort": ["../src/external/fast-sort"],
       "pacote": ["../src/external/pacote"],
+      "picomatch": ["../src/external/picomatch"],
       "@socketsecurity/lib": ["../../socket-lib/dist/index.d.ts"],
       "@socketsecurity/lib/*": ["../../socket-lib/dist/*"],
       "@socketsecurity/registry": [
diff --git a/scripts/build-externals/config.mjs b/scripts/build-externals/config.mjs
@@ -21,11 +21,16 @@ export const externalPackages = [
   { name: 'semver', bundle: false },
   // Utilities
   { name: 'debug', bundle: true },
-  { name: 'del', bundle: true },
-  { name: 'fast-glob', bundle: true },
+  // pico-pack: picomatch, del, fast-glob
+  { name: 'pico-pack', bundle: true },
+  // pico-pack internals - individual packages now just re-export from pico-pack bundle (no bundling needed)
+  { name: 'del', bundle: false },
+  { name: 'fast-glob', bundle: false },
   { name: 'fast-sort', bundle: true },
   { name: 'get-east-asian-width', bundle: true },
-  { name: 'picomatch', bundle: true },
+  // inquirer-pack: Bundle all @inquirer packages together.
+  { name: 'inquirer-pack', bundle: true },
+  { name: 'picomatch', bundle: false },
   { name: 'spdx-correct', bundle: true },
   { name: 'spdx-expression-parse', bundle: true },
   { name: 'streaming-iterables', bundle: true },
@@ -62,6 +67,7 @@ export const scopedPackages = [
       'search',
       'select',
     ],
+    bundle: false,
     optional: true,
   },
   {
diff --git a/scripts/build-externals/orchestrator.mjs b/scripts/build-externals/orchestrator.mjs
@@ -101,7 +101,17 @@ async function bundleAllPackages(options = {}) {
       // Multiple packages in scope.
       for (const pkg of packages) {
         const outputPath = path.join(scopeDir, `${pkg}.js`)
-        if (optional) {
+        if (bundle === false) {
+          // Copy non-bundled file as-is (thin re-export wrapper)
+          const srcPath = path.join(
+            rootDir,
+            'src',
+            'external',
+            scope,
+            `${pkg}.js`,
+          )
+          await fs.copyFile(srcPath, outputPath)
+        } else if (optional) {
           try {
             const size = await bundlePackage(`${scope}/${pkg}`, outputPath, {
               quiet,
diff --git a/scripts/validate/external-esm-cjs.mjs b/scripts/validate/external-esm-cjs.mjs
@@ -63,6 +63,14 @@ function getExternalModules(dir) {
   })
 }
 
+// Packages that legitimately only export { default } (ESM default exports).
+// These are optional @inquirer packages that use ESM default export pattern.
+const DEFAULT_ONLY_ALLOWED = new Set([
+  '@inquirer/confirm.js',
+  '@inquirer/input.js',
+  '@inquirer/password.js',
+])
+
 /**
  * Check if module exports work correctly for both CJS and ESM.
  */
@@ -71,6 +79,11 @@ async function checkModuleExports(filePath) {
   const normalizedPath = normalizePath(relativePath)
   const issues = []
 
+  // Skip validation for packages that legitimately only export default.
+  if (DEFAULT_ONLY_ALLOWED.has(normalizedPath)) {
+    return { path: normalizedPath, ok: true, issues: [] }
+  }
+
   // Test 1: CJS require() - should work without .default
   let cjsModule
   try {
diff --git a/scripts/validate/external-exports.mjs b/scripts/validate/external-exports.mjs
@@ -61,6 +61,14 @@ function getExternalModules(dir) {
   return modules
 }
 
+// Packages that legitimately only export { default } (ESM default exports).
+// These are optional @inquirer packages that use ESM default export pattern.
+const DEFAULT_ONLY_ALLOWED = new Set([
+  '@inquirer/confirm.js',
+  '@inquirer/input.js',
+  '@inquirer/password.js',
+])
+
 /**
  * Check if an external module export is usable without .default.
  */
@@ -77,7 +85,11 @@ function checkExternalExport(filePath) {
       const keys = Object.keys(mod)
 
       // If only key is 'default', it's wrapped incorrectly
+      // UNLESS it's in the allowed list of packages that legitimately only export default
       if (keys.length === 1 && keys[0] === 'default') {
+        if (DEFAULT_ONLY_ALLOWED.has(normalizedPath)) {
+          return { path: normalizedPath, ok: true, keys: 1 }
+        }
         return {
           path: normalizedPath,
           ok: false,
diff --git a/src/external/@inquirer/checkbox.js b/src/external/@inquirer/checkbox.js
@@ -1,3 +1,5 @@
 'use strict'
 
-module.exports = require('@inquirer/checkbox')
+// Re-export from inquirer-pack bundle for better deduplication.
+const { checkbox } = require('../inquirer-pack')
+module.exports = checkbox
diff --git a/src/external/@inquirer/confirm.js b/src/external/@inquirer/confirm.js
@@ -1,3 +1,5 @@
 'use strict'
 
-module.exports = require('@inquirer/confirm')
+// Re-export from inquirer-pack bundle for better deduplication.
+const { confirm } = require('../inquirer-pack')
+module.exports = confirm
diff --git a/src/external/@inquirer/input.js b/src/external/@inquirer/input.js
@@ -1,3 +1,5 @@
 'use strict'
 
-module.exports = require('@inquirer/input')
+// Re-export from inquirer-pack bundle for better deduplication.
+const { input } = require('../inquirer-pack')
+module.exports = input
diff --git a/src/external/@inquirer/password.js b/src/external/@inquirer/password.js
@@ -1,3 +1,5 @@
 'use strict'
 
-module.exports = require('@inquirer/password')
+// Re-export from inquirer-pack bundle for better deduplication.
+const { password } = require('../inquirer-pack')
+module.exports = password
diff --git a/src/external/@inquirer/search.js b/src/external/@inquirer/search.js
@@ -1,3 +1,5 @@
 'use strict'
 
-module.exports = require('@inquirer/search')
+// Re-export from inquirer-pack bundle for better deduplication.
+const { search } = require('../inquirer-pack')
+module.exports = search
diff --git a/src/external/@inquirer/select.js b/src/external/@inquirer/select.js
@@ -1,3 +1,5 @@
 'use strict'
 
-module.exports = require('@inquirer/select')
+// Re-export from inquirer-pack bundle for better deduplication.
+const { select } = require('../inquirer-pack')
+module.exports = select
diff --git a/src/external/del.js b/src/external/del.js
@@ -1,9 +1,6 @@
 'use strict'
 
-// Export only what we use to reduce bundle size
-const { deleteAsync, deleteSync } = require('del')
+// Re-export from pico-pack bundle.
+const { del } = require('./pico-pack.js')
 
-module.exports = {
-  deleteAsync,
-  deleteSync,
-}
+module.exports = del
diff --git a/src/external/fast-glob.js b/src/external/fast-glob.js
@@ -1,13 +1,6 @@
 'use strict'
 
-// Export only what we use to reduce bundle size
-const fastGlob = require('fast-glob')
+// Re-export from pico-pack bundle.
+const { glob } = require('./pico-pack.js')
 
-// Export the methods we use
-module.exports = fastGlob.globStream
-  ? {
-      glob: fastGlob,
-      globStream: fastGlob.globStream,
-      globSync: fastGlob.sync,
-    }
-  : fastGlob
+module.exports = glob
diff --git a/src/external/inquirer-pack.d.ts b/src/external/inquirer-pack.d.ts
@@ -0,0 +1,18 @@
+import type * as checkbox from '@inquirer/checkbox'
+import type * as confirm from '@inquirer/confirm'
+import type * as input from '@inquirer/input'
+import type * as password from '@inquirer/password'
+import type * as search from '@inquirer/search'
+import type * as select from '@inquirer/select'
+
+export interface InquirerPack {
+  checkbox: typeof checkbox
+  confirm: typeof confirm
+  input: typeof input
+  password: typeof password
+  search: typeof search
+  select: typeof select
+}
+
+declare const inquirerPack: InquirerPack
+export default inquirerPack
diff --git a/src/external/inquirer-pack.js b/src/external/inquirer-pack.js
@@ -0,0 +1,20 @@
+'use strict'
+
+// inquirer-pack: Bundle all @inquirer packages together.
+// These packages share dependencies and are commonly used together for interactive CLI prompts.
+
+const checkbox = require('@inquirer/checkbox')
+const confirm = require('@inquirer/confirm')
+const input = require('@inquirer/input')
+const password = require('@inquirer/password')
+const search = require('@inquirer/search')
+const select = require('@inquirer/select')
+
+module.exports = {
+  checkbox,
+  confirm,
+  input,
+  password,
+  search,
+  select,
+}
diff --git a/src/external/pico-pack.d.ts b/src/external/pico-pack.d.ts
@@ -0,0 +1,16 @@
+import type * as delTypes from 'del'
+import type * as fastGlobTypes from 'fast-glob'
+import type picomatchType from 'picomatch'
+
+export interface PicoPack {
+  del: Pick<typeof delTypes, 'deleteAsync' | 'deleteSync'>
+  glob: {
+    glob: typeof fastGlobTypes
+    globStream: typeof fastGlobTypes.globStream
+    globSync: typeof fastGlobTypes.sync
+  }
+  picomatch: typeof picomatchType
+}
+
+declare const picoPack: PicoPack
+export default picoPack
diff --git a/src/external/pico-pack.js b/src/external/pico-pack.js
@@ -0,0 +1,31 @@
+'use strict'
+
+// pico-pack: Bundle picomatch, del, and fast-glob together.
+// These packages all depend on picomatch for glob pattern matching.
+// Bundling them together eliminates code duplication where picomatch
+// is bundled separately within del (252KB) and fast-glob (200KB).
+
+const picomatch = require('picomatch')
+const { deleteAsync, deleteSync } = require('del')
+const fastGlob = require('fast-glob')
+
+// Re-create del structure.
+const del = {
+  deleteAsync,
+  deleteSync,
+}
+
+// Re-create fast-glob structure.
+const glob = fastGlob.globStream
+  ? {
+      glob: fastGlob,
+      globStream: fastGlob.globStream,
+      globSync: fastGlob.sync,
+    }
+  : fastGlob
+
+module.exports = {
+  del,
+  glob,
+  picomatch,
+}
diff --git a/src/external/picomatch.js b/src/external/picomatch.js
@@ -1,3 +1,6 @@
 'use strict'
 
-module.exports = require('picomatch')
+// Re-export from pico-pack bundle.
+const { picomatch } = require('./pico-pack.js')
+
+module.exports = picomatch
diff --git a/test/unit/build-externals.test.mts b/test/unit/build-externals.test.mts
@@ -181,20 +181,45 @@ describe('build-externals', () => {
 
   it('should have @inquirer modules properly bundled', async () => {
     const requiredInquirerModules = [
+      'checkbox',
+      'confirm',
       'input',
       'password',
       'search',
-      'confirm',
       'select',
     ]
     const inquirerDir = path.join(distExternalDir, '@inquirer')
+    const inquirerPackPath = path.join(distExternalDir, 'inquirer-pack.js')
 
     try {
       await fs.access(inquirerDir)
     } catch {
       expect.fail(`@inquirer directory not found at ${inquirerDir}`)
     }
 
+    // Check that inquirer-pack bundle exists and is properly sized.
+    try {
+      const [packStat, packContent] = await Promise.all([
+        fs.stat(inquirerPackPath),
+        fs.readFile(inquirerPackPath, 'utf8'),
+      ])
+
+      if (packStat.size <= 10_000) {
+        expect.fail(
+          `inquirer-pack should be properly bundled (> 10KB), got ${packStat.size} bytes`,
+        )
+      }
+
+      if (isStubReexport(packContent)) {
+        expect.fail('inquirer-pack should not be a stub re-export')
+      }
+    } catch (error) {
+      expect.fail(
+        `inquirer-pack not found or not properly bundled at ${inquirerPackPath}: ${error instanceof Error ? error.message : String(error)}`,
+      )
+    }
+
+    // Check that individual @inquirer modules are thin wrappers.
     const checkPromises = requiredInquirerModules.map(async module => {
       const modulePath = path.join(inquirerDir, `${module}.js`)
 
@@ -204,18 +229,20 @@ describe('build-externals', () => {
           fs.readFile(modulePath, 'utf8'),
         ])
 
-        if (stat.size <= 1000) {
+        if (stat.size > 1000) {
           expect.fail(
-            `@inquirer/${module} should be properly bundled (> 1KB), got ${stat.size} bytes`,
+            `@inquirer/${module} should be a thin wrapper (< 1KB), got ${stat.size} bytes`,
           )
         }
 
-        if (isStubReexport(content)) {
-          expect.fail(`@inquirer/${module} should not be a stub re-export`)
+        if (!content.includes('inquirer-pack')) {
+          expect.fail(
+            `@inquirer/${module} should re-export from inquirer-pack bundle`,
+          )
         }
       } catch (error) {
         expect.fail(
-          `@inquirer/${module} not found or not properly bundled at ${modulePath}: ${error instanceof Error ? error.message : String(error)}`,
+          `@inquirer/${module} not found or not properly wrapped at ${modulePath}: ${error instanceof Error ? error.message : String(error)}`,
         )
       }
     })
