import { statSync } from 'node:fs' import { relative, resolve } from 'pathe' import { defineNuxtModule, resolveAlias, addTemplate, addPluginTemplate } from '@nuxt/kit' import type { Component, ComponentsDir, ComponentsOptions } from '@nuxt/schema' import { componentsPluginTemplate, componentsTemplate, componentsTypeTemplate } from './templates' import { scanComponents } from './scan' import { loaderPlugin } from './loader' import { TreeShakeTemplatePlugin } from './tree-shake' const isPureObjectOrString = (val: any) => (!Array.isArray(val) && typeof val === 'object') || typeof val === 'string' const isDirectory = (p: string) => { try { return statSync(p).isDirectory() } catch (_e) { return false } } function compareDirByPathLength ({ path: pathA }, { path: pathB }) { return pathB.split(/[\\/]/).filter(Boolean).length - pathA.split(/[\\/]/).filter(Boolean).length } const DEFAULT_COMPONENTS_DIRS_RE = /\/components$|\/components\/global$/ type getComponentsT = (mode?: 'client' | 'server' | 'all') => Component[] export default defineNuxtModule({ meta: { name: 'components', configKey: 'components' }, defaults: { dirs: [] }, setup (componentOptions, nuxt) { let componentDirs = [] const context = { components: [] as Component[] } const getComponents: getComponentsT = (mode) => { return (mode && mode !== 'all') ? context.components.filter(c => c.mode === mode || c.mode === 'all') : context.components } const normalizeDirs = (dir: any, cwd: string) => { if (Array.isArray(dir)) { return dir.map(dir => normalizeDirs(dir, cwd)).flat().sort(compareDirByPathLength) } if (dir === true || dir === undefined) { return [ { path: resolve(cwd, 'components/global'), global: true }, { path: resolve(cwd, 'components') } ] } if (typeof dir === 'string') { return { path: resolve(cwd, resolveAlias(dir)) } } if (!dir) { return [] } const dirs = (dir.dirs || [dir]).map(dir => typeof dir === 'string' ? { path: dir } : dir).filter(_dir => _dir.path) return dirs.map(_dir => ({ ..._dir, path: resolve(cwd, resolveAlias(_dir.path)) })) } // Resolve dirs nuxt.hook('app:resolve', async () => { // components/ dirs from all layers const allDirs = nuxt.options._layers .map(layer => normalizeDirs(layer.config.components, layer.config.srcDir)) .flat() await nuxt.callHook('components:dirs', allDirs) componentDirs = allDirs.filter(isPureObjectOrString).map((dir) => { const dirOptions: ComponentsDir = typeof dir === 'object' ? dir : { path: dir } const dirPath = resolveAlias(dirOptions.path) const transpile = typeof dirOptions.transpile === 'boolean' ? dirOptions.transpile : 'auto' const extensions = (dirOptions.extensions || nuxt.options.extensions).map(e => e.replace(/^\./g, '')) dirOptions.level = Number(dirOptions.level || 0) const present = isDirectory(dirPath) if (!present && !DEFAULT_COMPONENTS_DIRS_RE.test(dirOptions.path)) { // eslint-disable-next-line no-console console.warn('Components directory not found: `' + dirPath + '`') } return { global: componentOptions.global, ...dirOptions, // TODO: https://github.com/nuxt/framework/pull/251 enabled: true, path: dirPath, extensions, pattern: dirOptions.pattern || `**/*.{${extensions.join(',')},}`, ignore: [ '**/*{M,.m,-m}ixin.{js,ts,jsx,tsx}', // ignore mixins '**/*.d.ts', // .d.ts files ...(dirOptions.ignore || []) ], transpile: (transpile === 'auto' ? dirPath.includes('node_modules') : transpile) } }).filter(d => d.enabled) componentDirs = [ ...componentDirs.filter(dir => !dir.path.includes('node_modules')), ...componentDirs.filter(dir => dir.path.includes('node_modules')) ] nuxt.options.build!.transpile!.push(...componentDirs.filter(dir => dir.transpile).map(dir => dir.path)) }) // components.d.ts addTemplate({ ...componentsTypeTemplate, options: { getComponents } }) // components.plugin.mjs addPluginTemplate({ ...componentsPluginTemplate, options: { getComponents } }) // components.server.mjs addTemplate({ ...componentsTemplate, filename: 'components.server.mjs', options: { getComponents, mode: 'server' } }) // components.client.mjs addTemplate({ ...componentsTemplate, filename: 'components.client.mjs', options: { getComponents, mode: 'client' } }) nuxt.hook('vite:extendConfig', (config, { isClient }) => { const mode = isClient ? 'client' : 'server' config.resolve.alias['#components'] = resolve(nuxt.options.buildDir, `components.${mode}.mjs`) }) nuxt.hook('webpack:config', (configs) => { for (const config of configs) { const mode = config.name === 'server' ? 'server' : 'client' config.resolve.alias['#components'] = resolve(nuxt.options.buildDir, `components.${mode}.mjs`) } }) // Scan components and add to plugin nuxt.hook('app:templates', async () => { const newComponents = await scanComponents(componentDirs, nuxt.options.srcDir!) await nuxt.callHook('components:extend', newComponents) context.components = newComponents }) nuxt.hook('prepare:types', ({ references, tsConfig }) => { tsConfig.compilerOptions!.paths['#components'] = [relative(nuxt.options.rootDir, resolve(nuxt.options.buildDir, 'components'))] references.push({ path: resolve(nuxt.options.buildDir, 'components.d.ts') }) }) // Watch for changes nuxt.hook('builder:watch', async (event, path) => { if (!['add', 'unlink'].includes(event)) { return } const fPath = resolve(nuxt.options.srcDir, path) if (componentDirs.find(dir => fPath.startsWith(dir.path))) { await nuxt.callHook('builder:generateApp') } }) nuxt.hook('vite:extendConfig', (config, { isClient }) => { config.plugins = config.plugins || [] config.plugins.push(loaderPlugin.vite({ sourcemap: nuxt.options.sourcemap, getComponents, mode: isClient ? 'client' : 'server' })) if (nuxt.options.experimental.treeshakeClientOnly) { config.plugins.push(TreeShakeTemplatePlugin.vite({ sourcemap: nuxt.options.sourcemap, getComponents })) } }) nuxt.hook('webpack:config', (configs) => { configs.forEach((config) => { config.plugins = config.plugins || [] config.plugins.push(loaderPlugin.webpack({ sourcemap: nuxt.options.sourcemap, getComponents, mode: config.name === 'client' ? 'client' : 'server' })) if (nuxt.options.experimental.treeshakeClientOnly) { config.plugins.push(TreeShakeTemplatePlugin.webpack({ sourcemap: nuxt.options.sourcemap, getComponents })) } }) }) } })