fix(module): harden module management flows

Author: danielroe

packages/nuxt-cli/src/commands/module/_autocomplete.ts

@@ -19,10 +19,6 @@ interface AutocompleteResult {
   cancelled: boolean
 }
 
-/**
- * Interactive fuzzy search for selecting Nuxt modules
- * Returns object with selected module npm package names and cancellation status
- */
 export async function selectModulesAutocomplete(options: AutocompleteOptions): Promise<AutocompleteResult> {
   const { modules, message = 'Search and select modules:' } = options
 
@@ -31,7 +27,6 @@ export async function selectModulesAutocomplete(options: AutocompleteOptions): P
     return { selected: [], cancelled: false }
   }
 
-  // Sort: official modules first, then alphabetically
   const sortedModules = modules.toSorted((a, b) => {
     if (a.type === 'official' && b.type !== 'official')
       return -1
@@ -40,26 +35,28 @@ export async function selectModulesAutocomplete(options: AutocompleteOptions): P
     return a.npm.localeCompare(b.npm)
   })
 
-  // Setup fzf for fast fuzzy search
   const fzf = new Fzf(sortedModules, {
     selector: m => `${m.npm} ${m.name} ${m.category}`,
     casing: 'case-insensitive',
     tiebreakers: [byLengthAsc],
   })
 
-  // Build options for clack multiselect
   const clackOptions: Option<string>[] = sortedModules.map(m => ({
     value: m.npm,
     label: m.npm,
     hint: m.description.replace(TRAILING_DOT_RE, ''),
   }))
 
-  // Custom filter function using fzf for fuzzy matching
+  const matches = new Map<string, Set<string>>()
   const filter = (search: string, option: Option<string>): boolean => {
     if (!search)
       return true
-    const results = fzf.find(search)
-    return results.some(r => r.item.npm === option.value)
+    let results = matches.get(search)
+    if (!results) {
+      results = new Set(fzf.find(search).map(r => r.item.npm))
+      matches.set(search, results)
+    }
+    return results.has(option.value)
   }
 
   const result = await autocompleteMultiselect({
@@ -69,9 +66,7 @@ export async function selectModulesAutocomplete(options: AutocompleteOptions): P
     required: false,
   })
 
-  if (isCancel(result)) {
-    return { selected: [], cancelled: true }
-  }
-
-  return { selected: result, cancelled: false }
+  return isCancel(result)
+    ? { selected: [], cancelled: true }
+    : { selected: result, cancelled: false }
 }

packages/nuxt-cli/src/commands/module/_utils.ts

@@ -13,28 +13,6 @@ import { logger } from '../../utils/logger'
 import { relativeToProcess } from '../../utils/paths'
 import { cwdArgs, logLevelArgs } from '../_shared'
 
-export const categories = [
-  'Analytics',
-  'CMS',
-  'CSS',
-  'Database',
-  'Date',
-  'Deployment',
-  'Devtools',
-  'Extensions',
-  'Ecommerce',
-  'Fonts',
-  'Images',
-  'Libraries',
-  'Monitoring',
-  'Payment',
-  'Performance',
-  'Request',
-  'SEO',
-  'Security',
-  'UI',
-]
-
 interface NuxtApiModulesResponse {
   version: string
   generatedAt: string
@@ -90,7 +68,7 @@ export interface NuxtModule {
   github: string
   website: string
   learn_more: string
-  category: (typeof categories)[number]
+  category: string
   type: ModuleType
   maintainers: MaintainerInfo[]
   contributors?: GitHubContributor[]

packages/nuxt-cli/src/commands/module/add.ts

@@ -13,7 +13,7 @@ import { detectPackageManager, packageManagers } from 'nypm'
 import { resolve } from 'pathe'
 import { readPackageJSON } from 'pkg-types'
 import { joinURL } from 'ufo'
-import { satisfies } from 'verkit'
+import { findMaxSatisfying, satisfies } from 'verkit'
 
 import { runCommandDef as runCommand } from '../../run-command'
 import { addNuxtConfigEntries, createNuxtConfig, readNuxtConfig } from '../../utils/config'
@@ -88,7 +88,7 @@ export function defineAddCommand({ layers = false }: { layers?: boolean } = {})
         process.exit(1)
       }
 
-      // If no modules specified, show interactive search
+      let modulesDB: NuxtModule[]
       if (modules.length === 0) {
         const modulesSpinner = spinner()
         modulesSpinner.start('Fetching available modules')
@@ -102,28 +102,36 @@ export function defineAddCommand({ layers = false }: { layers?: boolean } = {})
           getNuxtVersion(cwd),
         ])
 
-        const compatibleModules = allModules.filter(m =>
+        modulesDB = allModules
+        const compatibleModules = modulesDB.filter(m =>
           !m.compatibility.nuxt || checkNuxtCompatibility(m, nuxtVersion),
         )
 
         modulesSpinner.stop('Modules loaded')
 
-        const result = await selectModulesAutocomplete({
+        const selection = await selectModulesAutocomplete({
           modules: compatibleModules,
           message: 'Search modules to add (Esc to finish):',
         })
+        modules = selection.selected
 
-        if (result.selected.length === 0) {
+        if (modules.length === 0) {
           cancel('No modules selected.')
           process.exit(0)
         }
-
-        modules = result.selected
+      }
+      else {
+        modulesDB = await fetchModules().catch((err) => {
+          logNetworkError(err, { url: MODULES_API_URL, level: 'warn', prefix: 'Cannot search in the Nuxt Modules database.' })
+          return []
+        })
       }
 
+      let nuxtVersionPromise: Promise<string> | undefined
+      const getProjectNuxtVersion = () => nuxtVersionPromise ||= getNuxtVersion(cwd)
       const resolvedModules: ResolvedModule[] = []
-      for (const moduleName of modules) {
-        const resolvedModule = await resolveModule(moduleName, cwd)
+      for (const moduleName of new Set(modules)) {
+        const resolvedModule = await resolveModule(moduleName, cwd, modulesDB, getProjectNuxtVersion)
         if (resolvedModule) {
           resolvedModules.push(resolvedModule)
         }
@@ -142,7 +150,6 @@ export function defineAddCommand({ layers = false }: { layers?: boolean } = {})
         process.exit(1)
       }
 
-      // Run prepare command if install is not skipped
       if (!ctx.args.skipInstall) {
         await runCommand(prepareCommand, forwardCommandArgs(ctx.args))
       }
@@ -154,7 +161,6 @@ export default defineAddCommand()
 
 // -- Internal Utils --
 async function addModules(modules: ResolvedModule[], { skipInstall = false, skipConfig = false, cwd, dev = false, packageManager: packageManagerName, logLevel }: { skipInstall?: boolean, skipConfig?: boolean, cwd: string, dev?: boolean, packageManager?: string, logLevel?: string }, projectPkg: PackageJson): Promise<boolean> {
-  // Add dependencies
   if (!skipInstall) {
     const installedModules: ResolvedModule[] = []
     const notInstalledModules: ResolvedModule[] = []
@@ -230,7 +236,6 @@ async function addModules(modules: ResolvedModule[], { skipInstall = false, skip
     }
   }
 
-  // Update nuxt.config.ts
   if (!skipConfig) {
     try {
       let config = await readNuxtConfig(cwd)
@@ -258,6 +263,7 @@ async function addModules(modules: ResolvedModule[], { skipInstall = false, skip
     catch (error) {
       logger.error(`Failed to update ${styleText('cyan', 'nuxt.config')}: ${(error as Error).message}`)
       logger.error(`Please manually add ${styleText('cyan', modules.map(module => module.specifier).join(', '))} to ${styleText('cyan', 'nuxt.config.ts')}`)
+      return false
     }
   }
 
@@ -342,7 +348,7 @@ export default defineNuxtConfig({
 })`
 }
 
-async function resolveModule(moduleName: string, cwd: string): Promise<ModuleResolution> {
+async function resolveModule(moduleName: string, cwd: string, modulesDB: NuxtModule[], getProjectNuxtVersion: () => Promise<string>): Promise<ModuleResolution> {
   const spec = parseModuleSpec(moduleName)
 
   if (!spec) {
@@ -353,11 +359,6 @@ async function resolveModule(moduleName: string, cwd: string): Promise<ModuleRes
   let { pkgName, pkgVersion } = spec
   let subpath = spec.subpath
 
-  const modulesDB = await fetchModules().catch((err) => {
-    logNetworkError(err, { url: MODULES_API_URL, level: 'warn', prefix: 'Cannot search in the Nuxt Modules database.' })
-    return []
-  })
-
   const bareName = subpath ? `${pkgName}/${subpath}` : pkgName
   const matchedModule = modulesDB.find(
     module =>
@@ -377,8 +378,7 @@ async function resolveModule(moduleName: string, cwd: string): Promise<ModuleRes
   }
 
   if (matchedModule && matchedModule.compatibility.nuxt) {
-    // Get local Nuxt version
-    const nuxtVersion = await getNuxtVersion(cwd)
+    const nuxtVersion = await getProjectNuxtVersion()
 
     // Check for Module Compatibility
     if (!checkNuxtCompatibility(matchedModule, nuxtVersion)) {
@@ -449,7 +449,7 @@ async function resolveModule(moduleName: string, cwd: string): Promise<ModuleRes
     version = pkgDetails['dist-tags'][version]
   }
   else {
-    version = Object.keys(pkgDetails.versions)?.findLast(v => satisfies(v, version)) || version
+    version = findMaxSatisfying(Object.keys(pkgDetails.versions || {}), version) || version
   }
 
   const pkg = pkgDetails.versions[version!] || {}

packages/nuxt-cli/src/commands/module/remove.ts

@@ -64,8 +64,6 @@ export default defineCommand({
       process.exit(1)
     }
 
-    // With no inputs, the multiselect picker runs inside `removeModules` against the
-    // configured modules. Otherwise resolve aliases/names to canonical npm package names.
     const installedNames = getProjectDependencies(projectPkg)
 
     const needsDB = modules.some(m => !installedNames.has(m) && !installedNames.has(basePackageName(m)))
@@ -84,19 +82,18 @@ export default defineCommand({
 
     const proceed = await removeModules(resolvedModules, { ...ctx.args, cwd }, projectPkg)
 
-    if (!proceed) {
-      process.exit(0)
+    if (proceed !== true) {
+      process.exit(proceed === false ? 1 : 0)
     }
 
-    // Run prepare command if uninstall is not skipped
     if (!ctx.args.skipInstall) {
       await runCommand(prepareCommand, forwardCommandArgs(ctx.args))
     }
   },
 })
 
 // -- Internal Utils --
-async function removeModules(modules: string[], { skipInstall = false, skipConfig = false, cwd }: { skipInstall?: boolean, skipConfig?: boolean, cwd: string }, projectPkg: PackageJson): Promise<boolean> {
+async function removeModules(modules: string[], { skipInstall = false, skipConfig = false, cwd }: { skipInstall?: boolean, skipConfig?: boolean, cwd: string }, projectPkg: PackageJson): Promise<boolean | undefined> {
   const removedFromConfig: string[] = []
   const dependencies = getProjectDependencies(projectPkg)
 
@@ -118,7 +115,7 @@ async function removeModules(modules: string[], { skipInstall = false, skipConfi
 
       if (isCancel(picked)) {
         cancel('No modules selected.')
-        return false
+        return
       }
 
       toRemove = new Set(picked as string[])
@@ -140,17 +137,21 @@ async function removeModules(modules: string[], { skipInstall = false, skipConfi
         removedFromConfig.push(...names)
       }
 
-      await removeNuxtConfigEntries(config, doomed).catch((error) => {
+      try {
+        await removeNuxtConfigEntries(config, doomed)
+      }
+      catch (error) {
         logger.error(`Failed to update ${styleText('cyan', 'nuxt.config')}: ${(error as Error).message}`)
-        logger.error(`Please manually remove ${styleText('cyan', modules.join(', ') || 'the relevant modules')} from ${styleText('cyan', 'nuxt.config.ts')}`)
-      })
+        logger.error(`Please manually remove ${styleText('cyan', [...toRemove].join(', ') || 'the relevant modules')} from ${styleText('cyan', 'nuxt.config.ts')}`)
+        return false
+      }
     }
 
     if (modules.length === 0 && removedFromConfig.length === 0) {
       cancel(config
         ? `No modules configured in ${styleText('cyan', 'nuxt.config')}.`
         : `No ${styleText('cyan', 'nuxt.config')} found in ${styleText('cyan', relativeToProcess(cwd))}.`)
-      return false
+      return
     }
   }
 
@@ -202,7 +203,7 @@ async function removeModules(modules: string[], { skipInstall = false, skipConfi
 
       if (isCancel(alsoRemove)) {
         cancel('Aborted.')
-        return false
+        return
       }
 
       if (alsoRemove) {
@@ -249,22 +250,21 @@ function resolveModuleName(input: string, modulesDB: NuxtModule[], installed: Se
     || m.aliases?.includes(input),
   )
 
-  return matched?.npm || input
+  return matched?.npm ? basePackageName(matched.npm) : input
 }
 
 async function findOrphanedPeers(removing: string[], projectPkg: PackageJson, cwd: string): Promise<OrphanedPeer[]> {
   const projectDeps = getProjectDependencies(projectPkg)
   const removingSet = new Set(removing)
 
-  // peer name -> first removed module that declares it
   const candidates = new Map<string, string>()
   for (const m of removing) {
     const pkg = await readDependencyPackageJson(m, cwd)
     if (!pkg?.peerDependencies) {
       continue
     }
     for (const peer of Object.keys(pkg.peerDependencies)) {
-      if (!projectDeps.has(peer) || removingSet.has(peer) || candidates.has(peer)) {
+      if (pkg.peerDependenciesMeta?.[peer]?.optional || !projectDeps.has(peer) || removingSet.has(peer) || candidates.has(peer)) {
         continue
       }
       candidates.set(peer, m)
@@ -275,13 +275,10 @@ async function findOrphanedPeers(removing: string[], projectPkg: PackageJson, cw
     return []
   }
 
-  // Strike out peers that another retained dep still needs
   const stillNeeded = new Set<string>()
-  for (const dep of projectDeps) {
-    if (removingSet.has(dep) || candidates.has(dep)) {
-      continue
-    }
-    const depPkg = await readDependencyPackageJson(dep, cwd)
+  const retained = [...projectDeps].filter(dep => !removingSet.has(dep) && !candidates.has(dep))
+  const packages = await Promise.all(retained.map(dep => readDependencyPackageJson(dep, cwd)))
+  for (const depPkg of packages) {
     if (!depPkg) {
       continue
     }

packages/nuxt-cli/src/commands/module/search.ts

@@ -41,11 +41,21 @@ export default defineCommand({
     },
   },
   async setup(ctx) {
-    const nuxtVersion = await getNuxtVersion(ctx.args.cwd).catch(() => DEFAULT_NUXT_VERSION)
+    const nuxtVersion = ctx.args.nuxtVersion
+      ? normalizeNuxtVersion(ctx.args.nuxtVersion)
+      : await getNuxtVersion(ctx.args.cwd).catch(() => DEFAULT_NUXT_VERSION)
     return findModuleByKeywords(ctx.args._.join(' '), nuxtVersion)
   },
 })
 
+export function normalizeNuxtVersion(version: string): string {
+  return /^\d+$/.test(version)
+    ? `${version}.0.0`
+    : /^\d+\.\d+$/.test(version)
+      ? `${version}.0`
+      : version
+}
+
 async function findModuleByKeywords(query: string, nuxtVersion: string) {
   const allModules = await fetchModules().catch((err) => {
     logNetworkError(err, { url: MODULES_API_URL })
@@ -84,7 +94,7 @@ async function findModuleByKeywords(query: string, nuxtVersion: string) {
       delete res.homepage
     }
     if (item.name === item.npm) {
-      delete res.packageName
+      delete res.package
     }
     return res
   })