路径解析
Nuxt Kit 提供了一系列工具来帮助您解决路径问题。这些函数允许您相对于当前模块解决具有未知名称或扩展名的路径。
有时您需要解决相对当前模块的路径问题，这些路径具有未知名称或扩展名。例如，您可能想要添加一个位于模块同一目录中的插件。为了处理这些情况，nuxt 提供了一系列工具来解决路径问题。resolvePath 和 resolveAlias 用于解决相对于当前模块的路径问题。findPath 用于在给定的路径中找到第一个存在的文件。createResolver 用于创建相对于基本路径的解析器。
resolvePath
解决一个文件的完整路径或目录，同时尊重 Nuxt 别名和扩展选项。如果路径无法解决，将返回规范化后的输入路径。
类型
async function resolvePath (path: string, options?: ResolvePathOptions): Promise<string>
参数
path
类型: string
必需: true
要解决的路径。
options
类型: ResolvePathOptions
默认: {}
要传递给解析器的选项。这个对象可以有以下属性:
cwd(可选)
类型:string
默认:process.cwd()
当前工作目录。alias(可选)
类型:Record<string, string>
默认:{}
别名映射。extensions(可选)
类型:string[]
默认:['.js', '.mjs', '.ts', '.jsx', '.tsx', '.json']
尝试的扩展名。
示例
// https://github.com/P4sca1/nuxt-headlessui
import { defineNuxtModule, resolvePath } from '@nuxt/kit'
import { join } from 'pathe'
const headlessComponents: ComponentGroup[] = [
{
relativePath: 'combobox/combobox.js',
chunkName: 'headlessui/combobox',
exports: [
'Combobox',
'ComboboxLabel',
'ComboboxButton',
'ComboboxInput',
'ComboboxOptions',
'ComboboxOption'
]
},
]
export default defineNuxtModule({
meta: {
name: 'nuxt-headlessui',
configKey: 'headlessui',
},
defaults: {
prefix: 'Headless'
},
async setup (options) {
const entrypoint = await resolvePath('@headlessui/vue')
const root = join(entrypoint, '../components')
for (const group of headlessComponents) {
for (const e of group.exports) {
addComponent(
{
name: e,
export: e,
filePath: join(root, group.relativePath),
chunkName: group.chunkName,
mode: 'all'
}
)
}
}
}
})
resolveAlias
解决遵守 Nuxt 别名选项的路径别名。
类型
function resolveAlias (path: string, alias?: Record<string, string>): string
参数
path
类型: string
必需: true
要解决的路径。
alias
类型: Record<string, string>
默认: {}
别名映射。如果没有提供，它将从 nuxt.options.alias 读取。
findPath
尝试在给定的路径中解决第一个存在的文件。
类型
async function findPath (paths: string | string[], options?: ResolvePathOptions, pathType: 'file' | 'dir'): Promise<string | null>
interface ResolvePathOptions {
cwd?: string
alias?: Record<string, string>
extensions?: string[]
}
参数
paths
类型: string | string[]
必需: true
要解决的路径或路径数组。
options
类型: ResolvePathOptions
默认: {}
要传递给解析器的选项。这个对象可以有以下属性:
cwd(可选)
类型:string
默认:process.cwd()
当前工作目录。alias(可选)
类型:Record<string, string>
默认:{}
别名映射。extensions(可选)
类型:string[]
默认:['.js', '.mjs', '.ts', '.jsx', '.tsx', '.json']
尝试的扩展名。
pathType
类型: 'file' | 'dir'
默认: 'file'
要解决的路径类型。如果设置为 'file'，函数将尝试解决一个文件。如果设置为 'dir'，函数将尝试解决一个目录。
createResolver
创建相对于基本路径的解析器。
类型
function createResolver (basePath: string | URL): Resolver
interface Resolver {
resolve (...path: string[]): string
resolvePath (path: string, options?: ResolvePathOptions): Promise<string>
}
interface ResolvePathOptions {
cwd?: string
alias?: Record<string, string>
extensions?: string[]
}
参数
basePath
类型: string
必需: true
相对于哪个路径来解析。
示例
// https://github.com/vuejs/pinia/blob/v2/packages/nuxt
import {
defineNuxtModule,
isNuxt2,
createResolver,
} from '@nuxt/kit'
export default defineNuxtModule({
setup(options, nuxt) {
const resolver = createResolver(import.meta.url)
nuxt.hook('modules:done', () => {
if (isNuxt2()) {
addPlugin(resolver.resolve('./runtime/plugin.vue2'))
} else {
addPlugin(resolver.resolve('./runtime/plugin.vue3'))
}
})
}
})