Update command-registry.ts

Author: gonzaloriestra

packages/cli/src/command-registry.ts

@@ -1,128 +1,111 @@
 /**
- * Lazy command registry.
+ * Manifest-based lazy command loader.
  *
- * Maps each command ID to a dynamic import function that loads ONLY that command's module.
- * This avoids importing the entire index.ts (which pulls in `\@shopify/app`, `\@shopify/theme`,
- * `\@shopify/cli-hydrogen`, etc.) just to run a single command.
+ * Reads the oclif manifest to discover which package owns each command, then
+ * derives the entry point from the command ID using a naming convention:
+ *   dist/cli/commands/\{id with : replaced by /\}.js
+ *
+ * This lets us dynamically import ONLY the specific command file instead of
+ * loading every command from the package index.
+ *
+ * Commands from external plugins (cli-hydrogen, oclif plugins) fall back to
+ * importing the full package.
  */
+import {dirname, joinPath, moduleDirectory} from '@shopify/cli-kit/node/path'
+import {readFileSync} from 'fs'
+import {createRequire} from 'module'
+import {pathToFileURL} from 'url'
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type CommandLoader = () => Promise<any>
-
-/* eslint-disable @typescript-eslint/naming-convention */
-const cliCommands: Record<string, CommandLoader> = {
-  version: () => import('./cli/commands/version.js'),
-  search: () => import('./cli/commands/search.js'),
-  upgrade: () => import('./cli/commands/upgrade.js'),
-  'auth:logout': () => import('./cli/commands/auth/logout.js'),
-  'auth:login': () => import('./cli/commands/auth/login.js'),
-  'debug:command-flags': () => import('./cli/commands/debug/command-flags.js'),
-  'kitchen-sink:async': () => import('./cli/commands/kitchen-sink/async.js'),
-  'kitchen-sink:prompts': () => import('./cli/commands/kitchen-sink/prompts.js'),
-  'kitchen-sink:static': () => import('./cli/commands/kitchen-sink/static.js'),
-  'kitchen-sink': () => import('./cli/commands/kitchen-sink/index.js'),
-  'doctor-release': () => import('./cli/commands/doctor-release/doctor-release.js'),
-  'doctor-release:theme': () => import('./cli/commands/doctor-release/theme/index.js'),
-  'docs:generate': () => import('./cli/commands/docs/generate.js'),
-  help: () => import('./cli/commands/help.js'),
-  'notifications:list': () => import('./cli/commands/notifications/list.js'),
-  'notifications:generate': () => import('./cli/commands/notifications/generate.js'),
-  'cache:clear': () => import('./cli/commands/cache/clear.js'),
+const require = createRequire(import.meta.url)
+
+interface ManifestCommand {
+  customPluginName?: string
+  pluginName?: string
 }
-/* eslint-enable @typescript-eslint/naming-convention */
-
-const appCommandIds = [
-  'app:build',
-  'app:bulk:cancel',
-  'app:bulk:status',
-  'app:deploy',
-  'app:dev',
-  'app:dev:clean',
-  'app:logs',
-  'app:logs:sources',
-  'app:import-custom-data-definitions',
-  'app:import-extensions',
-  'app:info',
-  'app:init',
-  'app:release',
-  'app:config:link',
-  'app:config:use',
-  'app:config:pull',
-  'app:env:pull',
-  'app:env:show',
-  'app:execute',
-  'app:bulk:execute',
-  'app:generate:schema',
-  'app:function:build',
-  'app:function:replay',
-  'app:function:run',
-  'app:function:info',
-  'app:function:schema',
-  'app:function:typegen',
-  'app:generate:extension',
-  'app:versions:list',
-  'app:webhook:trigger',
-  'webhook:trigger',
-  'demo:watcher',
-  'organization:list',
-]
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function searchForDefault(module: any): any {
-  if (module.default?.run) return module.default
-  for (const value of Object.values(module)) {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    if (typeof (value as any) === 'function' && typeof (value as any).run === 'function') return value
+let cachedCommands: Record<string, ManifestCommand> | undefined
+
+function getManifestCommands(): Record<string, ManifestCommand> {
+  if (!cachedCommands) {
+    const manifestPath = joinPath(moduleDirectory(import.meta.url), '..', 'oclif.manifest.json')
+    cachedCommands = JSON.parse(readFileSync(manifestPath, 'utf8')).commands
   }
-  return undefined
+  return cachedCommands!
+}
+
+const packageDirCache = new Map<string, string>()
+
+function resolvePackageDir(packageName: string): string {
+  let dir = packageDirCache.get(packageName)
+  if (!dir) {
+    dir = dirname(require.resolve(`${packageName}/package.json`))
+    packageDirCache.set(packageName, dir)
+  }
+  return dir
 }
 
+const entryPointOverrides: Record<string, string> = {
+  'app:logs:sources': 'dist/cli/commands/app/app-logs/sources.js',
+  'demo:watcher': 'dist/cli/commands/app/demo/watcher.js',
+  'kitchen-sink': 'dist/cli/commands/kitchen-sink/index.js',
+  'doctor-release': 'dist/cli/commands/doctor-release/doctor-release.js',
+  'doctor-release:theme': 'dist/cli/commands/doctor-release/theme/index.js',
+}
+
+function entryPointForCommand(id: string): string {
+  return entryPointOverrides[id] ?? `dist/cli/commands/${id.replace(/:/g, '/')}.js`
+}
+
+const packagesWithPerFileLoading = new Set(['@shopify/cli', '@shopify/app', '@shopify/theme'])
+
 /**
  * Load a command class by its ID.
- * Returns the command class, or undefined if not found.
+ *
+ * Looks up the command in the oclif manifest to find the owning package,
+ * derives the file path from the command ID, and imports only that file.
+ * Falls back to importing the full package for external plugins.
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export async function loadCommand(id: string): Promise<any | undefined> {
-  // Check CLI-local commands first
-  const cliLoader = cliCommands[id]
-  if (cliLoader) {
-    const module = await cliLoader()
-    return searchForDefault(module)
-  }
+  const commands = getManifestCommands()
+  const entry = commands[id]
+  if (!entry) return undefined
 
-  // App commands
-  if (appCommandIds.includes(id)) {
-    const {commands} = await import('@shopify/app')
-    return commands[id]
-  }
+  const packageName = entry.customPluginName ?? entry.pluginName
+  if (!packageName) return undefined
 
-  // Theme commands
-  if (id.startsWith('theme:')) {
-    const themeModule = await import('@shopify/theme')
-    return (themeModule.default as Record<string, unknown>)?.[id]
+  if (packagesWithPerFileLoading.has(packageName)) {
+    const packageDir = resolvePackageDir(packageName)
+    const entryPoint = entryPointForCommand(id)
+    const modulePath = pathToFileURL(joinPath(packageDir, entryPoint)).href
+    const module = await import(modulePath)
+    return module.default
   }
 
-  // Hydrogen commands
-  if (id.startsWith('hydrogen:')) {
+  return loadCommandFromPackage(id, packageName)
+}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+async function loadCommandFromPackage(id: string, packageName: string): Promise<any | undefined> {
+  if (packageName === '@shopify/cli-hydrogen') {
     const {COMMANDS} = await import('@shopify/cli-hydrogen')
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     return (COMMANDS as any)?.[id]
   }
 
-  // Plugin commands
-  if (id === 'commands') {
+  if (packageName === '@oclif/plugin-commands') {
     const {commands} = await import('@oclif/plugin-commands')
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     return (commands as any)[id]
   }
 
-  if (id.startsWith('plugins')) {
+  if (packageName === '@oclif/plugin-plugins') {
     const {commands} = await import('@oclif/plugin-plugins')
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     return (commands as any)[id]
   }
 
-  if (id.startsWith('config:autocorrect')) {
+  if (packageName === '@shopify/plugin-did-you-mean') {
     const {DidYouMeanCommands} = await import('@shopify/plugin-did-you-mean')
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     return (DidYouMeanCommands as any)[id]