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
- */
 exportasyncfunctionselectModulesAutocomplete(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
 constsortedModules=modules.toSorted((a,b)=>{
 if(a.type==='official'&&b.type!=='official')
 return-1
@@ -40,26 +35,28 @@ export async function selectModulesAutocomplete(options: AutocompleteOptions): P
 returna.npm.localeCompare(b.npm)
 })
 
-// Setup fzf for fast fuzzy search
 constfzf=newFzf(sortedModules,{
 selector: m=>`${m.npm}${m.name}${m.category}`,
 casing: 'case-insensitive',
 tiebreakers: [byLengthAsc],
 })
 
-// Build options for clack multiselect
 constclackOptions: 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
+constmatches=newMap<string,Set<string>>()
 constfilter=(search: string,option: Option<string>): boolean=>{
 if(!search)
 returntrue
-constresults=fzf.find(search)
-returnresults.some(r=>r.item.npm===option.value)
+letresults=matches.get(search)
+if(!results){
+results=newSet(fzf.find(search).map(r=>r.item.npm))
+matches.set(search,results)
+}
+returnresults.has(option.value)
 }
 
 constresult=awaitautocompleteMultiselect({
@@ -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}
+returnisCancel(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'
 
-exportconstcategories=[
-'Analytics',
-'CMS',
-'CSS',
-'Database',
-'Date',
-'Deployment',
-'Devtools',
-'Extensions',
-'Ecommerce',
-'Fonts',
-'Images',
-'Libraries',
-'Monitoring',
-'Payment',
-'Performance',
-'Request',
-'SEO',
-'Security',
-'UI',
-]
-
 interfaceNuxtApiModulesResponse{
 version: string
 generatedAt: string
@@ -90,7 +68,7 @@ export interface NuxtModule {
 github: string
 website: string
 learn_more: string
-category: (typeofcategories)[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{runCommandDefasrunCommand}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
+letmodulesDB: NuxtModule[]
 if(modules.length===0){
 constmodulesSpinner=spinner()
 modulesSpinner.start('Fetching available modules')
@@ -102,28 +102,36 @@ export function defineAddCommand({ layers = false }: { layers?: boolean } = {})
 getNuxtVersion(cwd),
 ])
 
-constcompatibleModules=allModules.filter(m=>
+modulesDB=allModules
+constcompatibleModules=modulesDB.filter(m=>
 !m.compatibility.nuxt||checkNuxtCompatibility(m,nuxtVersion),
 )
 
 modulesSpinner.stop('Modules loaded')
 
-constresult=awaitselectModulesAutocomplete({
+constselection=awaitselectModulesAutocomplete({
 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=awaitfetchModules().catch((err)=>{
+logNetworkError(err,{url: MODULES_API_URL,level: 'warn',prefix: 'Cannot search in the Nuxt Modules database.'})
+return[]
+})
 }
 
+letnuxtVersionPromise: Promise<string>|undefined
+constgetProjectNuxtVersion=()=>nuxtVersionPromise||=getNuxtVersion(cwd)
 constresolvedModules: ResolvedModule[]=[]
-for(constmoduleNameofmodules){
-constresolvedModule=awaitresolveModule(moduleName,cwd)
+for(constmoduleNameofnewSet(modules)){
+constresolvedModule=awaitresolveModule(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){
 awaitrunCommand(prepareCommand,forwardCommandArgs(ctx.args))
 }
@@ -154,7 +161,6 @@ export default defineAddCommand()
 
 // -- Internal Utils --
 asyncfunctionaddModules(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){
 constinstalledModules: ResolvedModule[]=[]
 constnotInstalledModules: ResolvedModule[]=[]
@@ -230,7 +236,6 @@ async function addModules(modules: ResolvedModule[], { skipInstall = false, skip
 }
 }
 
-// Update nuxt.config.ts
 if(!skipConfig){
 try{
 letconfig=awaitreadNuxtConfig(cwd)
@@ -258,6 +263,7 @@ async function addModules(modules: ResolvedModule[], { skipInstall = false, skip
 catch(error){
 logger.error(`Failed to update ${styleText('cyan','nuxt.config')}: ${(errorasError).message}`)
 logger.error(`Please manually add ${styleText('cyan',modules.map(module=>module.specifier).join(', '))} to ${styleText('cyan','nuxt.config.ts')}`)
+returnfalse
 }
 }
 
@@ -342,7 +348,7 @@ export default defineNuxtConfig({
 })`
 }
 
-asyncfunctionresolveModule(moduleName: string,cwd: string): Promise<ModuleResolution>{
+asyncfunctionresolveModule(moduleName: string,cwd: string,modulesDB: NuxtModule[],getProjectNuxtVersion: ()=>Promise<string>): Promise<ModuleResolution>{
 constspec=parseModuleSpec(moduleName)
 
 if(!spec){
@@ -353,11 +359,6 @@ async function resolveModule(moduleName: string, cwd: string): Promise<ModuleRes
 let{ pkgName, pkgVersion }=spec
 letsubpath=spec.subpath
 
-constmodulesDB=awaitfetchModules().catch((err)=>{
-logNetworkError(err,{url: MODULES_API_URL,level: 'warn',prefix: 'Cannot search in the Nuxt Modules database.'})
-return[]
-})
-
 constbareName=subpath ? `${pkgName}/${subpath}` : pkgName
 constmatchedModule=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
-constnuxtVersion=awaitgetNuxtVersion(cwd)
+constnuxtVersion=awaitgetProjectNuxtVersion()
 
 // 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
 }
 
 constpkg=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.
 constinstalledNames=getProjectDependencies(projectPkg)
 
 constneedsDB=modules.some(m=>!installedNames.has(m)&&!installedNames.has(basePackageName(m)))
@@ -84,19 +82,18 @@ export default defineCommand({
 
 constproceed=awaitremoveModules(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){
 awaitrunCommand(prepareCommand,forwardCommandArgs(ctx.args))
 }
 },
 })
 
 // -- Internal Utils --
-asyncfunctionremoveModules(modules: string[],{ skipInstall =false, skipConfig =false, cwd }: {skipInstall?: boolean,skipConfig?: boolean,cwd: string},projectPkg: PackageJson): Promise<boolean>{
+asyncfunctionremoveModules(modules: string[],{ skipInstall =false, skipConfig =false, cwd }: {skipInstall?: boolean,skipConfig?: boolean,cwd: string},projectPkg: PackageJson): Promise<boolean|undefined>{
 constremovedFromConfig: string[]=[]
 constdependencies=getProjectDependencies(projectPkg)
 
@@ -118,7 +115,7 @@ async function removeModules(modules: string[], { skipInstall = false, skipConfi
 
 if(isCancel(picked)){
 cancel('No modules selected.')
-returnfalse
+return
 }
 
 toRemove=newSet(pickedasstring[])
@@ -140,17 +137,21 @@ async function removeModules(modules: string[], { skipInstall = false, skipConfi
 removedFromConfig.push(...names)
 }
 
-awaitremoveNuxtConfigEntries(config,doomed).catch((error)=>{
+try{
+awaitremoveNuxtConfigEntries(config,doomed)
+}
+catch(error){
 logger.error(`Failed to update ${styleText('cyan','nuxt.config')}: ${(errorasError).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')}`)
+returnfalse
+}
 }
 
 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))}.`)
-returnfalse
+return
 }
 }
 
@@ -202,7 +203,7 @@ async function removeModules(modules: string[], { skipInstall = false, skipConfi
 
 if(isCancel(alsoRemove)){
 cancel('Aborted.')
-returnfalse
+return
 }
 
 if(alsoRemove){
@@ -249,22 +250,21 @@ function resolveModuleName(input: string, modulesDB: NuxtModule[], installed: Se
 ||m.aliases?.includes(input),
 )
 
-returnmatched?.npm||input
+returnmatched?.npm? basePackageName(matched.npm) :input
 }
 
 asyncfunctionfindOrphanedPeers(removing: string[],projectPkg: PackageJson,cwd: string): Promise<OrphanedPeer[]>{
 constprojectDeps=getProjectDependencies(projectPkg)
 constremovingSet=newSet(removing)
 
-// peer name -> first removed module that declares it
 constcandidates=newMap<string,string>()
 for(constmofremoving){
 constpkg=awaitreadDependencyPackageJson(m,cwd)
 if(!pkg?.peerDependencies){
 continue
 }
 for(constpeerofObject.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
 conststillNeeded=newSet<string>()
-for(constdepofprojectDeps){
-if(removingSet.has(dep)||candidates.has(dep)){
-continue
-}
-constdepPkg=awaitreadDependencyPackageJson(dep,cwd)
+constretained=[...projectDeps].filter(dep=>!removingSet.has(dep)&&!candidates.has(dep))
+constpackages=awaitPromise.all(retained.map(dep=>readDependencyPackageJson(dep,cwd)))
+for(constdepPkgofpackages){
 if(!depPkg){
 continue
 }

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

@@ -41,11 +41,21 @@ export default defineCommand({
 },
 },
 asyncsetup(ctx){
-constnuxtVersion=awaitgetNuxtVersion(ctx.args.cwd).catch(()=>DEFAULT_NUXT_VERSION)
+constnuxtVersion=ctx.args.nuxtVersion
+ ? normalizeNuxtVersion(ctx.args.nuxtVersion)
+ : awaitgetNuxtVersion(ctx.args.cwd).catch(()=>DEFAULT_NUXT_VERSION)
 returnfindModuleByKeywords(ctx.args._.join(' '),nuxtVersion)
 },
 })
 
+exportfunctionnormalizeNuxtVersion(version: string): string{
+return/^\d+$/.test(version)
+ ? `${version}.0.0`
+ : /^\d+\.\d+$/.test(version)
+ ? `${version}.0`
+ : version
+}
+
 asyncfunctionfindModuleByKeywords(query: string,nuxtVersion: string){
 constallModules=awaitfetchModules().catch((err)=>{
 logNetworkError(err,{url: MODULES_API_URL})
@@ -84,7 +94,7 @@ async function findModuleByKeywords(query: string, nuxtVersion: string) {
 deleteres.homepage
 }
 if(item.name===item.npm){
-deleteres.packageName
+deleteres.package
 }
 returnres
 })