Vite Plugin HTML 使用教程

Vite Plugin HTML 使用教程

vite-plugin-html项目地址:https://gitcode.com/gh_mirrors/vit/vite-plugin-html

1. 项目的目录结构及介绍

vite-plugin-html/
├── src/
│   ├── index.ts
│   ├── options.ts
│   ├── transform.ts
│   └── utils.ts
├── types/
│   └── index.d.ts
├── package.json
├── README.md
└── tsconfig.json

• src/: 包含项目的主要源代码文件。
  • index.ts: 插件的入口文件。
  • options.ts: 插件选项的定义和处理。
  • transform.ts: HTML 文件的转换逻辑。
  • utils.ts: 工具函数。
• types/: 包含 TypeScript 类型定义文件。
  • index.d.ts: 插件的类型定义。
• package.json: 项目的依赖和脚本配置。
• README.md: 项目的说明文档。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts，它是插件的入口点。该文件导出了插件的主要功能，包括 HTML 文件的转换和处理。

import { createPlugin } from './options';

export default createPlugin;

createPlugin 函数负责创建并返回插件实例，它接受用户配置的选项，并根据这些选项进行相应的处理。

3. 项目的配置文件介绍

项目的配置文件主要是 package.json 和 tsconfig.json。

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。以下是一些关键部分：

{
  "name": "vite-plugin-html",
  "version": "2.1.0",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  "scripts": {
    "build": "tsc",
    "prepare": "npm run build"
  },
  "dependencies": {
    "vite": "^2.0.0"
  },
  "devDependencies": {
    "typescript": "^4.0.0"
  }
}

• name: 项目名称。
• version: 项目版本。
• main: 项目的主入口文件。
• types: 类型定义文件。
• scripts: 包含构建和准备脚本。
• dependencies: 生产环境依赖。
• devDependencies: 开发环境依赖。

tsconfig.json

tsconfig.json 文件是 TypeScript 的配置文件，定义了编译选项和源文件路径。

{
  "compilerOptions": {
    "target": "esnext",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src"]
}

• compilerOptions: 编译选项。
  • target: 编译目标。
  • module: 模块系统。
  • outDir: 输出目录。
  • strict: 启用严格模式。
  • esModuleInterop: 启用 ES 模块互操作。
  • skipLibCheck: 跳过库文件类型检查。
  • forceConsistentCasingInFileNames: 强制文件名一致性。
• include: 包含的源文件路径。

vite-plugin-html项目地址:https://gitcode.com/gh_mirrors/vit/vite-plugin-html