Nuxt/packages/nuxt/src/head/module.ts

84 lines
3.1 KiB
TypeScript
Raw Normal View History

import { resolve } from 'pathe'
import { addBuildPlugin, addComponent, addPlugin, addTemplate, defineNuxtModule, tryResolveModule } from '@nuxt/kit'
import type { NuxtOptions } from '@nuxt/schema'
import { distDir } from '../dirs'
import { UnheadImportsPlugin } from './plugins/unhead-imports'
const components = ['NoScript', 'Link', 'Base', 'Title', 'Meta', 'Style', 'Head', 'Html', 'Body']
export default defineNuxtModule<NuxtOptions['unhead']>({
meta: {
name: 'nuxt:meta',
configKey: 'unhead',
},
2025-01-22 06:11:38 +00:00
async setup (options, nuxt) {
const runtimeDir = resolve(distDir, 'head/runtime')
2025-01-21 09:38:51 +00:00
// Transpile @unhead/vue
nuxt.options.build.transpile.push('@unhead/vue')
const isNuxtV4 = nuxt.options._majorVersion === 4 || nuxt.options.future?.compatibilityVersion === 4
// Register components
const componentsPath = resolve(runtimeDir, 'components')
for (const componentName of components) {
addComponent({
name: componentName,
filePath: componentsPath,
export: componentName,
// built-in that we do not expect the user to override
priority: 10,
// kebab case version of these tags is not valid
kebabName: componentName,
})
}
// allow @unhead/vue server composables to be tree-shaken from the client bundle
if (!nuxt.options.dev) {
nuxt.options.optimization.treeShake.composables.client['@unhead/vue'] = [
'useServerHead', 'useServerSeoMeta', 'useServerHeadSafe',
]
}
nuxt.options.alias['#unhead/composables'] = resolve(runtimeDir, 'composables', isNuxtV4 ? 'v4' : 'v3')
addBuildPlugin(UnheadImportsPlugin({
sourcemap: !!nuxt.options.sourcemap.server,
rootDir: nuxt.options.rootDir,
}))
2025-02-14 07:04:03 +00:00
const unheadPlugins = await tryResolveModule('@unhead/vue/plugins', nuxt.options.modulesDir) || '@unhead/vue/plugins'
addTemplate({
2025-01-14 09:03:48 +00:00
filename: 'unhead-options.mjs',
2025-01-22 06:11:38 +00:00
getContents () {
2025-02-12 01:44:19 +00:00
if (isNuxtV4 && !options.legacy) {
2025-01-14 09:03:48 +00:00
return `export default {}`
}
2025-01-14 09:03:48 +00:00
// v1 unhead legacy options
const disableCapoSorting = !nuxt.options.experimental.headNext
2025-02-14 07:04:03 +00:00
return `import { DeprecationsPlugin, PromisesPlugin, TemplateParamsPlugin, AliasSortingPlugin } from ${JSON.stringify(unheadPlugins)};
2025-01-14 09:03:48 +00:00
export default {
2025-01-22 06:11:38 +00:00
disableCapoSorting: ${Boolean(disableCapoSorting)},
2025-02-14 07:04:03 +00:00
plugins: [DeprecationsPlugin, PromisesPlugin, TemplateParamsPlugin, AliasSortingPlugin],
2025-01-14 09:03:48 +00:00
}`
},
})
addTemplate({
filename: 'unhead.config.mjs',
getContents () {
return [
`export const renderSSRHeadOptions = ${JSON.stringify(options.renderSSRHeadOptions || {})}`,
].join('\n')
},
})
// template is only exposed in nuxt context, expose in nitro context as well
nuxt.hooks.hook('nitro:config', (config) => {
2025-01-14 09:03:48 +00:00
config.virtual!['#internal/unhead-options.mjs'] = () => nuxt.vfs['#build/unhead-options.mjs']
config.virtual!['#internal/unhead.config.mjs'] = () => nuxt.vfs['#build/unhead.config.mjs']
})
// Add library-specific plugin
addPlugin({ src: resolve(runtimeDir, 'plugins/unhead') })
},
})