@ contember/vite-plugin (英语)

概览

@contember/vite-plugin 是一个 Vite 插件,旨在增强 Contember 应用程序的 Vite 构建进程。 它提供配置选项和中间软件来简化开发并构建进程.

安装

yarn add @contember/vite-plugin

使用量

import { defineConfig } from 'vite'
import { contember } from '@contember/vite-plugin'

export default defineConfig({
  plugins: [contember()]
})

选项

插件接受可选选项 ContemberOptions 对象 :

type ContemberOptions = {
  buildVersion?: boolean
  disableMiddleware?: boolean
  appPath?: string
}

• buildVersion: (可选) 当 true (默认),在 HTML 输出中添加构建版本元标记.
• disableMiddleware: (可选) 当 true,禁用内置中间软件.
• appPath: (可选)指定应用程序路径。 默认为 /app。 。 。 .

特征

1. 项目名称注射

插件从命令行参数中自动检测到 Contember 项目名称,并将它作为环境变量注入应用程序 :

import.meta.env.VITE_CONTEMBER_ADMIN_PROJECT_NAME

2. 构建配置

• 设置基准 URL 为 /。 。 。 .
• 配置构建输入以包含root和app HTML文件.

3. 开发服务器中间软件

除非已禁用,插件会添加中间软件来处理应用程序路径的路由,确保应用程序的请求得到妥善处理.

4. 构建版本标签

启用( 默认) 时, 插件在 HTML 输出中添加一个元标记, 并带有独特的构建版本散列 :

<meta name="contember-build-version" content="[MD5_HASH]">

此用于过时的应用程序检查 .

类型脚本支持

该插件包括了TypeScript定义,并被配置为与TypeScript项目合作.

兼容性

此插件与Vite版本4和5兼容.