解決

ソース
Nuxt Kit は、パスの解決に役立つ一連のユーティリティを提供します。これらの関数を使用すると、現在のモジュールからの相対パスや、名前や拡張子が不明なパスを解決できます。

現在のモジュールからの相対パスや、名前や拡張子が不明なパスを解決する必要がある場合があります。たとえば、モジュールと同じディレクトリにあるプラグインを追加したい場合があります。これらのケースを処理するために、Nuxt はパスを解決するための一連のユーティリティを提供します。resolvePath と resolveAlias は、現在のモジュールからの相対パスを解決するために使用されます。findPath は、指定されたパス内で最初に存在するファイルを見つけるために使用されます。createResolver は、ベースパスからのリゾルバーを作成するために使用されます。

resolvePath

Nuxt のエイリアスと拡張子オプションを考慮して、ファイルまたはディレクトリへの完全なパスを解決します。パスが解決できない場合は、正規化された入力パスが返されます。

使用方法

import { defineNuxtModule, resolvePath } from '@nuxt/kit'

export default defineNuxtModule({
  async setup () {
    const entrypoint = await resolvePath('@unhead/vue')
    console.log(`Unhead entrypoint is ${entrypoint}`)
  },
})

タイプ

function resolvePath (path: string, options?: ResolvePathOptions): Promise<string>

パラメーター

path: 解決するパス。

options: リゾルバーに渡すオプション。このオブジェクトには以下のプロパティがあります。

プロパティタイプ必須説明
cwd文字列falseパスを解決する際のベース。デフォルトは Nuxt の rootDir です。
aliasRecord<string, string>falseエイリアスのオブジェクト。デフォルトは Nuxt の設定されたエイリアスです。
extensionsstring[]false試行するファイル拡張子。デフォルトは Nuxt の設定された拡張子です。
virtualブール値falseNuxt VFS に存在するファイル（例えば、Nuxt テンプレートとして）を解決するかどうか。
fallbackToOriginalブール値false解決されたパスが存在しない場合に、正規化された入力パスを返す代わりに元のパスにフォールバックするかどうか。

例

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: 解決するパス。

alias: エイリアスのオブジェクト。指定しない場合、nuxt.options.alias から読み取られます。

findPath

指定されたパスの中で最初に存在するファイルを解決しようとします。

使用方法

import { defineNuxtModule, findPath } from '@nuxt/kit'
import { join } from 'pathe'

export default defineNuxtModule({
  async setup (_, nuxt) {
    // Resolve main (app.vue)
    const mainComponent = await findPath([
      join(nuxt.options.srcDir, 'App'),
      join(nuxt.options.srcDir, 'app'),
    ])
  },
})

タイプ

function findPath (paths: string | string[], options?: ResolvePathOptions, pathType: 'file' | 'dir'): Promise<string | null>

パラメーター

paths: 解決するパスまたはパスの配列。

options: リゾルバーに渡すオプション。このオブジェクトには以下のプロパティがあります。

プロパティタイプ必須説明
cwd文字列falseパスを解決する際のベース。デフォルトは Nuxt の rootDir です。
aliasRecord<string, string>falseエイリアスのオブジェクト。デフォルトは Nuxt の設定されたエイリアスです。
extensionsstring[]false試行するファイル拡張子。デフォルトは Nuxt の設定された拡張子です。
virtualブール値falseNuxt VFS に存在するファイル（例えば、Nuxt テンプレートとして）を解決するかどうか。
fallbackToOriginalブール値false解決されたパスが存在しない場合に、正規化された入力パスを返す代わりに元のパスにフォールバックするかどうか。

createResolver

ベースパスからのリゾルバーを作成します。

createResolver についての Vue School のビデオを見る。

使用方法

import { createResolver, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  setup (_, nuxt) {
    const { resolve, resolvePath } = createResolver(import.meta.url)
  },
})

タイプ

function createResolver (basePath: string | URL): Resolver

パラメーター

basePath: 解決元のベースパス。文字列または URL を指定できます。

戻り値

createResolver 関数は、以下のプロパティを持つオブジェクトを返します。

プロパティタイプ説明
resolve(path: string) => stringベースパスに対する相対パスを解決する関数。
resolvePath(path: string, options?: ResolvePathOptions) => Promise<string>ベースパスに対する相対パスを解決し、Nuxt のエイリアスと拡張子オプションを考慮する関数。

例

import { createResolver, defineNuxtModule, isNuxt2 } 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'))
      }
    })
  },
})