import { existsSync, promises as fsp, lstatSync } from 'node:fs' import type { ModuleMeta, Nuxt, NuxtConfig, NuxtModule } from '@nuxt/schema' import { dirname, isAbsolute, join, resolve } from 'pathe' import { defu } from 'defu' import { isNuxt2 } from '../compatibility' import { useNuxt } from '../context' import { requireModule } from '../internal/cjs' import { importModule } from '../internal/esm' import { resolveAlias, resolvePath } from '../resolve' import { logger } from '../logger' const NODE_MODULES_RE = /[/\\]node_modules[/\\]/ /** Installs a module on a Nuxt instance. */ export async function installModule< T extends string | NuxtModule, Config extends Extract[number], [T, any]>, > (moduleToInstall: T, inlineOptions?: [Config] extends [never] ? any : Config[1], nuxt: Nuxt = useNuxt()) { const { nuxtModule, buildTimeModuleMeta } = await loadNuxtModuleInstance(moduleToInstall, nuxt) const localLayerModuleDirs = new Set() for (const l of nuxt.options._layers) { const srcDir = l.config.srcDir || l.cwd if (!NODE_MODULES_RE.test(srcDir)) { localLayerModuleDirs.add(resolve(srcDir, l.config?.dir?.modules || 'modules')) } } // Call module const res = ( isNuxt2() // @ts-expect-error Nuxt 2 `moduleContainer` is not typed ? await nuxtModule.call(nuxt.moduleContainer, inlineOptions, nuxt) : await nuxtModule(inlineOptions, nuxt) ) ?? {} if (res === false /* setup aborted */) { return } if (typeof moduleToInstall === 'string') { nuxt.options.build.transpile.push(normalizeModuleTranspilePath(moduleToInstall)) const directory = getDirectory(moduleToInstall) if (directory !== moduleToInstall && !localLayerModuleDirs.has(directory)) { nuxt.options.modulesDir.push(resolve(directory, 'node_modules')) } } nuxt.options._installedModules = nuxt.options._installedModules || [] const entryPath = typeof moduleToInstall === 'string' ? resolveAlias(moduleToInstall) : undefined if (typeof moduleToInstall === 'string' && entryPath !== moduleToInstall) { buildTimeModuleMeta.rawPath = moduleToInstall } nuxt.options._installedModules.push({ meta: defu(await nuxtModule.getMeta?.(), buildTimeModuleMeta), timings: res.timings, entryPath, }) } // --- Internal --- export function getDirectory (p: string) { try { // we need to target directories instead of module file paths themselves // /home/user/project/node_modules/module/index.js -> /home/user/project/node_modules/module return isAbsolute(p) && lstatSync(p).isFile() ? dirname(p) : p } catch (e) { // maybe the path is absolute but does not exist, allow this to bubble up } return p } export const normalizeModuleTranspilePath = (p: string) => { return getDirectory(p).split('node_modules/').pop() as string } export async function loadNuxtModuleInstance (nuxtModule: string | NuxtModule, nuxt: Nuxt = useNuxt()) { let buildTimeModuleMeta: ModuleMeta = {} // Import if input is string if (typeof nuxtModule === 'string') { const paths = [join(nuxtModule, 'nuxt'), join(nuxtModule, 'module'), nuxtModule] let error: unknown for (const path of paths) { try { const src = await resolvePath(path, { fallbackToOriginal: true }) // Prefer ESM resolution if possible nuxtModule = await importModule(src, nuxt.options.modulesDir).catch(() => null) ?? requireModule(src, { paths: nuxt.options.modulesDir }) // nuxt-module-builder generates a module.json with metadata including the version const moduleMetadataPath = join(dirname(src), 'module.json') if (existsSync(moduleMetadataPath)) { buildTimeModuleMeta = JSON.parse(await fsp.readFile(moduleMetadataPath, 'utf-8')) } break } catch (_err: unknown) { error = _err continue } } if (typeof nuxtModule !== 'function' && error) { logger.error(`Error while requiring module \`${nuxtModule}\`: ${error}`) throw error } } // Throw error if input is not a function if (typeof nuxtModule !== 'function') { throw new TypeError('Nuxt module should be a function: ' + nuxtModule) } return { nuxtModule, buildTimeModuleMeta } as { nuxtModule: NuxtModule, buildTimeModuleMeta: ModuleMeta } }