模板 - Nuxt Kit - Nuxt 中文文档

模板允许你在开发和构建时生成额外的文件。这些文件将在虚拟文件系统中可用，并可用于插件、布局、组件等。addTemplate 和 addTypeTemplate 允许你向 Nuxt 应用程序添加模板。updateTemplates 允许你根据过滤器重新生成模板。

`addTemplate`

在构建过程中将给定的模板渲染到项目的构建目录中。

类型

function addTemplate (template: NuxtTemplate | string): ResolvedNuxtTemplate

interface NuxtTemplate {
  src?: string
  filename?: string
  dst?: string
  options?: Record<string, any>
  getContents?: (data: Record<string, any>) => string | Promise<string>
  write?: boolean
}

interface ResolvedNuxtTemplate {
  src: string
  filename: string
  dst: string
  options: Record<string, any>
  getContents: (data: Record<string, any>) => string | Promise<string>
  write: boolean
  filename: string
  dst: string
}

参数

`template`

类型: NuxtTemplate | string

必需: true

一个模板对象或指向模板的字符串路径。如果提供了字符串，它将被转换为具有 src 设置为字符串值的模板对象。如果提供了模板对象，它必须具有以下属性：

src (可选)
类型: string
模板的路径。如果未提供 src，则必须提供 getContents。
filename (可选)
类型: string
模板的文件名。如果未提供 filename，它将从 src 路径生成。在这种情况下，需要 src 选项。
dst (可选)
类型: string
目标文件的路径。如果未提供 dst，它将从 filename 路径和 Nuxt 的 buildDir 选项生成。
options (可选)
类型: Options
传递给模板的选项。
getContents (可选)
类型: (data: Options) => string | Promise<string>
一个函数，它将被调用带有 options 对象。它应该返回一个字符串或一个 resolves 为字符串的 Promise。如果提供了 src，则将忽略此函数。
write (可选)
类型: boolean
如果设置为 true，模板将被写入目标文件。否则，模板将在虚拟文件系统中使用。

示例

// https://github.com/nuxt/bridge
import { addTemplate, defineNuxtModule } from '@nuxt/kit'
import { defu } from 'defu'

export default defineNuxtModule({
  setup(options, nuxt) {
    const globalMeta = defu(nuxt.options.app.head, {
      charset: options.charset,
      viewport: options.viewport
    })

    addTemplate({
      filename: 'meta.config.mjs',
      getContents: () => 'export default ' + JSON.stringify({ globalMeta, mixinKey: 'setup' })
    })
  }
})

`addTypeTemplate`

在构建期间将给定的模板渲染到项目 buildDir，然后将其注册为类型。

类型

function addTypeTemplate (template: NuxtTypeTemplate | string): ResolvedNuxtTemplate

interface NuxtTemplate {
  src?: string
  filename?: string
  dst?: string
  options?: Record<string, any>
  getContents?: (data: Record<string, any>) => string | Promise<string>
}

interface ResolvedNuxtTemplate {
  src: string
  filename: string
  dst: string
  options: Record<string, any>
  getContents: (data: Record<string, any>) => string | Promise<string>
  write: boolean
  filename: string
  dst: string
}

参数

`template`

类型: NuxtTypeTemplate | string

必需: true

src (可选)
类型: string
模板的路径。如果未提供 src，则必须提供 getContents。
filename (可选)
类型: string
模板的文件名。如果未提供 filename，它将从 src 路径生成。在这种情况下，需要 src 选项。
dst (可选)
类型: string
目标文件的路径。如果未提供 dst，它将从 filename 路径和 Nuxt 的 buildDir 选项生成。
options (可选)
类型: Options
传递给模板的选项。
getContents (可选)
类型: (data: Options) => string | Promise<string>
一个函数，它将被调用带有 options 对象。它应该返回一个字符串或一个解决为字符串的承诺。如果提供了 src，则将忽略此函数。

示例

// https://github.com/Hebilicious/nuxtpress
import { addTypeTemplate, defineNuxtModule } from "@nuxt/kit"

export default defineNuxtModule({
  setup() {
    addTypeTemplate({
      filename: "types/markdown.d.ts",
      getContents: () => /* ts */`
      declare module '*.md' {
        import type { ComponentOptions } from 'vue'
        const Component: ComponentOptions
        export default Component
      }`
    })
  }
}

`updateTemplates`

根据过滤器重新生成匹配的模板。如果没有提供过滤器，所有模板都将被重新生成。

类型

async function updateTemplates (options: UpdateTemplatesOptions): void

interface UpdateTemplatesOptions {
  filter?: (template: ResolvedNuxtTemplate) => boolean
}

interface ResolvedNuxtTemplate {
  src: string
  filename: string
  dst: string
  options: Record<string, any>
  getContents: (data: Record<string, any>) => string | Promise<string>
  write: boolean
  filename: string
  dst: string
}

参数

`options`

类型: UpdateTemplatesOptions

默认: {}

传递给模板的选项。这个对象可以有以下属性：

filter (可选)
类型: (template: ResolvedNuxtTemplate) => boolean
一个函数，它将被调用带有 template 对象。它应该返回一个布尔值，指示模板是否应该被重新生成。如果未提供 filter，所有模板都将被重新生成。

示例

// https://github.com/nuxt/nuxt
import { defineNuxtModule, updateTemplates } from '@nuxt/kit'

export default defineNuxtModule({
  setup(options, nuxt) {
    // 当某个页面更改时，观察并重新构建路由模板列表
    nuxt.hook('builder:watch', async (event, relativePath) => {
      if (event === 'change') { return }

      const path = resolve(nuxt.options.srcDir, relativePath)
      if (updateTemplatePaths.some(dir => path.startsWith(dir))) {
        await updateTemplates({
          filter: template => template.filename === 'routes.mjs'
        })
      }
    })
  }
})

运行时配置

Nuxt Kit 提供了一系列工具，帮助您访问和修改 Nuxt 运行时配置。

Nitro

Nuxt Kit 提供了一组工具，帮助你与 Nitro 一起工作。这些函数允许你添加服务器处理程序、插件和预渲染路由。