@meng-xi/vite-plugin 0.0.3 → 0.0.5

package/README-en.md

@@ -1,150 +1,182 @@
-**English** | [中文](./README.md)
-
-<div align="center">
-	<a href="https://github.com/MengXi-Studio/vite-plugin">
-		<img alt="梦曦工作室 Logo" width="215" src="https://github.com/MengXi-Studio/vite-plugin/blob/master/packages/docs/src/public/logo.svg">
-	</a>
-	<br>
-	<h1>@meng-xi/vite-plugin</h1>
-
-[![license](https://img.shields.io/github/license/MengXi-Studio/vite-plugin.svg)](LICENSE) [![npm](https://img.shields.io/npm/v/@meng-xi/vite-plugin?color=blue)](https://www.npmjs.com/package/@meng-xi/vite-plugin)
-![npm](https://img.shields.io/npm/dt/@meng-xi/vite-plugin?color=green)
-
-</div>
-
-> - This is a toolkit that provides practical plugins for Vite, helping developers simplify the build process and improve development efficiency.
-> - Extends Vite build process functionality, providing automated processing solutions for common build tasks.
-> - All plugins support detailed configuration options, allowing customization based on project needs to meet different usage scenarios.
-> - Plugins provide error handling mechanisms to ensure build processes can catch errors, improving build reliability.
-> - Adopts modular design, plugins can be used individually or in combination, flexibly responding to different project needs.
-
----
-
-Start reading the [documentation](https://mengxi-studio.github.io/vite-plugin/).
-
-## Quick Start
-
-### Installation
-
-Install `@meng-xi/vite-plugin` using a package manager:
-
-```bash
-# Using npm
-npm install @meng-xi/vite-plugin --save-dev
-
-# Using yarn
-yarn add @meng-xi/vite-plugin --save-dev
-
-# Using pnpm
-pnpm add @meng-xi/vite-plugin --save-dev
-```
-
-### Basic Usage
-
-Import and use the plugins in your Vite configuration file:
-
-```typescript
-import { defineConfig } from 'vite'
-import { copyFile, injectIco } from '@meng-xi/vite-plugin'
-
-export default defineConfig({
-	plugins: [
-		// Copy file plugin
-		copyFile({
-			sourceDir: 'src/assets',
-			targetDir: 'dist/assets'
-		}),
-
-		// Inject icon plugin
-		injectIco({
-			base: '/assets'
-		})
-	]
-})
-```
-
-### Import All
-
-You can also use default import to import all plugins:
-
-```typescript
-import { defineConfig } from 'vite'
-import vitePlugin from '@meng-xi/vite-plugin'
-
-export default defineConfig({
-	plugins: [
-		// Copy file plugin
-		vitePlugin.copyFile({
-			sourceDir: 'src/assets',
-			targetDir: 'dist/assets'
-		}),
-
-		// Inject icon plugin
-		vitePlugin.injectIco({
-			base: '/assets'
-		})
-	]
-})
-```
-
-## Plugin Details
-
-### copyFile Plugin
-
-Used to copy files or directories to specified locations after Vite build is completed.
-
-**Configuration Options**:
-
-- `sourceDir`: Source directory path (required)
-- `targetDir`: Target directory path (required)
-- `overwrite`: Whether to overwrite existing files, default is `true`
-- `recursive`: Whether to recursively copy subdirectories, default is `true`
-- `verbose`: Whether to output detailed logs, default is `true`
-- `enabled`: Whether to enable the plugin, default is `true`
-
-### injectIco Plugin
-
-Used to inject website icon links into the head of HTML files during the Vite build process.
-
-**Configuration Options**:
-
-- `base`: Base path for icon files
-- `url`: Complete URL for the icon
-- `link`: Custom complete link tag HTML
-- `icons`: Custom icon array
-- `verbose`: Whether to output detailed logs, default is `true`
-- `enabled`: Whether to enable the plugin, default is `true`
-- `copyOptions`: Icon file copying configuration
-
-## Contribution
-
-Welcome to contribute to `@meng-xi/vite-plugin`. Here are the steps to contribute code:
-
-1. Fork the project: Fork this project on GitHub.
-2. Clone the code: Clone the forked project to your local machine.
-
-```bash
-git clone https://github.com/your-username/vite-plugin.git
-cd vite-plugin
-```
-
-3. Create a new branch: Create a new feature branch based on the `master` branch.
-
-```bash
-git checkout -b feature/your-feature
-```
-
-4. Commit changes: Ensure your code passes tests and commit your changes with clear commit messages.
-
-```bash
-git add .
-git commit -m "feat: add your feature description"
-```
-
-5. Push changes: Push your local branch to GitHub.
-
-```bash
-git push origin feature/your-feature
-```
-
-6. Create a PR: Create a Pull Request on GitHub and wait for review.
+**English** | [中文](./README.md)
+
+<div align="center">
+	<a href="https://github.com/MengXi-Studio/vite-plugin">
+		<img alt="MengXi Studio Logo" width="215" src="https://github.com/MengXi-Studio/vite-plugin/blob/master/packages/docs/src/public/logo.svg">
+	</a>
+	<br>
+	<h1>@meng-xi/vite-plugin</h1>
+	<p>A toolkit providing practical plugins for Vite, also a complete plugin development framework</p>
+
+[![license](https://img.shields.io/github/license/MengXi-Studio/vite-plugin.svg)](LICENSE) [![npm](https://img.shields.io/npm/v/@meng-xi/vite-plugin?color=blue)](https://www.npmjs.com/package/@meng-xi/vite-plugin)
+![npm](https://img.shields.io/npm/dt/@meng-xi/vite-plugin?color=green)
+
+</div>
+
+## Features
+
+- **Ready to Use** - Provides practical plugins for file copying, router generation, version management, icon injection
+- **Plugin Development Framework** - Exports core components like BasePlugin, Logger, Validator for building custom plugins
+- **Type Safe** - Complete TypeScript type definitions with configuration validators ensuring parameter correctness
+- **Flexible Configuration** - All plugins support detailed configuration to meet diverse scenario requirements
+
+## Documentation
+
+View full documentation: [https://mengxi-studio.github.io/vite-plugin/](https://mengxi-studio.github.io/vite-plugin/)
+
+## Installation
+
+```bash
+# npm
+npm install @meng-xi/vite-plugin -D
+
+# yarn
+yarn add @meng-xi/vite-plugin -D
+
+# pnpm
+pnpm add @meng-xi/vite-plugin -D
+```
+
+## Quick Start
+
+### Using Built-in Plugins
+
+```typescript
+import { defineConfig } from 'vite'
+import { copyFile, generateRouter, generateVersion, injectIco } from '@meng-xi/vite-plugin'
+
+export default defineConfig({
+	plugins: [
+		// Copy files
+		copyFile({
+			sourceDir: 'src/assets',
+			targetDir: 'dist/assets'
+		}),
+
+		// Generate router config (uni-app)
+		generateRouter({
+			pagesJsonPath: 'src/pages.json',
+			outputPath: 'src/router.config.ts'
+		}),
+
+		// Generate version
+		generateVersion({
+			format: 'datetime',
+			outputType: 'both'
+		}),
+
+		// Inject website icon
+		injectIco({
+			base: '/assets'
+		})
+	]
+})
+```
+
+### Developing Custom Plugins
+
+```typescript
+import { BasePlugin, createPluginFactory } from '@meng-xi/vite-plugin'
+import type { Plugin } from 'vite'
+
+interface MyPluginOptions {
+	path: string
+	enabled?: boolean
+	verbose?: boolean
+	errorStrategy?: 'throw' | 'log' | 'ignore'
+}
+
+class MyPlugin extends BasePlugin<MyPluginOptions> {
+	protected getDefaultOptions() {
+		return { path: './default' }
+	}
+
+	protected validateOptions(): void {
+		this.validator.field('path').required().string().validate()
+	}
+
+	protected getPluginName(): string {
+		return 'my-plugin'
+	}
+
+	protected addPluginHooks(plugin: Plugin): void {
+		plugin.buildStart = () => {
+			this.logger.info(`Plugin started with path: ${this.options.path}`)
+		}
+	}
+}
+
+export const myPlugin = createPluginFactory(MyPlugin)
+```
+
+## Built-in Plugins
+
+### copyFile
+
+Copy files or directories to specified locations after Vite build is completed.
+
+| Option      | Type    | Default | Description                                |
+| ----------- | ------- | ------- | ------------------------------------------ |
+| sourceDir   | string  | -       | Source directory path (required)           |
+| targetDir   | string  | -       | Target directory path (required)           |
+| overwrite   | boolean | true    | Whether to overwrite existing files        |
+| recursive   | boolean | true    | Whether to recursively copy subdirectories |
+| incremental | boolean | true    | Whether to enable incremental copying      |
+
+### generateRouter
+
+Automatically generate router configuration files based on uni-app project's `pages.json`.
+
+| Option               | Type         | Default                | Description                                      |
+| -------------------- | ------------ | ---------------------- | ------------------------------------------------ |
+| pagesJsonPath        | string       | 'src/pages.json'       | Path to pages.json file                          |
+| outputPath           | string       | 'src/router.config.ts' | Output file path                                 |
+| outputFormat         | 'ts' \| 'js' | 'ts'                   | Output file format                               |
+| nameStrategy         | string       | 'camelCase'            | Route name strategy                              |
+| includeSubPackages   | boolean      | true                   | Whether to include sub-package routes            |
+| watch                | boolean      | true                   | Whether to watch changes and auto-regenerate     |
+| metaMapping          | object       | -                      | Mapping from page style fields to meta           |
+| preserveRouteChanges | boolean      | true                   | Whether to preserve user modifications to routes |
+
+### generateVersion
+
+Automatically generate version numbers during the Vite build process.
+
+| Option     | Type   | Default               | Description                    |
+| ---------- | ------ | --------------------- | ------------------------------ |
+| format     | string | 'timestamp'           | Version format                 |
+| outputType | string | 'file'                | Output type                    |
+| outputFile | string | 'version.json'        | Output file path               |
+| defineName | string | '\_\_APP_VERSION\_\_' | Global variable name to inject |
+| prefix     | string | -                     | Version number prefix          |
+| suffix     | string | -                     | Version number suffix          |
+
+### injectIco
+
+Inject website icon links into the head of HTML files during the Vite build process.
+
+| Option      | Type   | Default | Description                     |
+| ----------- | ------ | ------- | ------------------------------- |
+| base        | string | -       | Base path for icon files        |
+| url         | string | -       | Complete URL for the icon       |
+| link        | string | -       | Custom complete link tag HTML   |
+| icons       | array  | -       | Custom icon array               |
+| copyOptions | object | -       | Icon file copying configuration |
+
+## Changelog
+
+See [GitHub Releases](https://github.com/MengXi-Studio/vite-plugin/releases)
+
+## Contributing
+
+Contributions are welcome! Please follow these steps:
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature/your-feature`
+3. Commit changes: `git commit -m "feat: your feature description"`
+4. Push to branch: `git push origin feature/your-feature`
+5. Create a Pull Request
+
+## License
+
+[MIT](LICENSE)

package/README.md

@@ -1,84 +1,182 @@
-**中文** | [English](./README-en.md)
-
-<div align="center">
-	<a href="https://github.com/MengXi-Studio/vite-plugin">
-		<img alt="梦曦工作室 Logo" width="215" src="https://github.com/MengXi-Studio/vite-plugin/blob/master/packages/docs/src/public/logo.svg">
-	</a>
-	<br>
-	<h1>@meng-xi/vite-plugin</h1>
-
-[![license](https://img.shields.io/github/license/MengXi-Studio/vite-plugin.svg)](LICENSE) [![npm](https://img.shields.io/npm/v/@meng-xi/vite-plugin?color=blue)](https://www.npmjs.com/package/@meng-xi/vite-plugin)
-![npm](https://img.shields.io/npm/dt/@meng-xi/vite-plugin?color=green)
-
-</div>
-
-## 简介
-
-`@meng-xi/vite-plugin` 是一个为 Vite 提供实用插件的工具包，帮助开发者简化构建流程，提高开发效率。
-
-## 特性
-
-- **增强 Vite 构建流程**：提供实用插件集合，扩展 Vite 功能，简化构建过程中的常见任务，提高开发效率
-- **模块化插件架构**：采用模块化设计，插件可单独使用或组合使用，灵活应对不同项目需求
-- **高度可配置**：所有功能支持详细配置选项，可根据项目需求自定义行为，满足多样化场景
-- **环境感知能力**：支持根据构建环境条件执行插件功能，智能控制不同环境下的行为
-- **详细日志输出**：提供可选的详细日志，帮助开发者了解执行过程，便于调试和问题排查
-- **类型安全**：完全使用 TypeScript 开发，提供完整类型定义，确保使用过程中的类型安全
-- **无缝集成**：与 Vite 构建流程无缝集成，无需复杂配置即可快速启用
-- **优化开发体验**：简化常见构建任务，减少手动操作，让开发者专注于核心业务逻辑
-
-## 文档
-
-开始阅读[文档地址](https://mengxi-studio.github.io/vite-plugin/)。
-
-## 安装
-
-使用包管理器安装 `@meng-xi/vite-plugin`：
-
-```bash
-# 使用 npm
-npm install @meng-xi/vite-plugin --save-dev
-
-# 使用 yarn
-yarn add @meng-xi/vite-plugin --save-dev
-
-# 使用 pnpm
-pnpm add @meng-xi/vite-plugin --save-dev
-```
-
-## 更新日志
-
-[CHANGELOG](https://github.com/MengXi-Studio/vite-plugin/releases)
-
-## 如何贡献
-
-欢迎为 `@meng-xi/vite-plugin` 贡献代码。以下是贡献代码的步骤：
-
-1. Fork 项目：在 GitHub 上 Fork 此项目。
-2. 克隆代码：将 Fork 后的项目克隆到您的本地机器。
-
-```bash
-git clone https://github.com/your-username/vite-plugin.git
-cd vite-plugin
-```
-
-3. 创建新分支：基于 `master` 分支创建一个新的功能分支。
-
-```bash
-git checkout -b feature/your-feature
-```
-
-4. 提交变更：确保您的代码通过了测试，并使用清晰的提交消息提交您的变更。
-
-```bash
-git add .
-git commit -m "feat: add your feature description"
-```
-
-5. Push 变更：将您的本地分支推送到 GitHub。
-
-```bash
-git push origin feature/your-feature
-```
-
-6. 创建 PR：在 GitHub 上创建一个 Pull Request，并等待审核。
+**中文** | [English](./README-en.md)
+
+<div align="center">
+	<a href="https://github.com/MengXi-Studio/vite-plugin">
+		<img alt="梦曦工作室 Logo" width="215" src="https://github.com/MengXi-Studio/vite-plugin/blob/master/packages/docs/src/public/logo.svg">
+	</a>
+	<br>
+	<h1>@meng-xi/vite-plugin</h1>
+	<p>一个为 Vite 提供实用插件的工具包，同时也是一个完整的插件开发框架</p>
+
+[![license](https://img.shields.io/github/license/MengXi-Studio/vite-plugin.svg)](LICENSE) [![npm](https://img.shields.io/npm/v/@meng-xi/vite-plugin?color=blue)](https://www.npmjs.com/package/@meng-xi/vite-plugin)
+![npm](https://img.shields.io/npm/dt/@meng-xi/vite-plugin?color=green)
+
+</div>
+
+## 特性
+
+- **开箱即用** - 提供文件复制、路由生成、版本管理、图标注入等实用插件
+- **插件开发框架** - 导出 BasePlugin、Logger、Validator 等核心组件，快速构建自定义插件
+- **类型安全** - 完整的 TypeScript 类型定义，配置验证器确保参数正确性
+- **灵活配置** - 所有插件支持详细配置，满足多样化场景需求
+
+## 文档
+
+查看完整文档：[https://mengxi-studio.github.io/vite-plugin/](https://mengxi-studio.github.io/vite-plugin/)
+
+## 安装
+
+```bash
+# npm
+npm install @meng-xi/vite-plugin -D
+
+# yarn
+yarn add @meng-xi/vite-plugin -D
+
+# pnpm
+pnpm add @meng-xi/vite-plugin -D
+```
+
+## 快速开始
+
+### 使用内置插件
+
+```typescript
+import { defineConfig } from 'vite'
+import { copyFile, generateRouter, generateVersion, injectIco } from '@meng-xi/vite-plugin'
+
+export default defineConfig({
+	plugins: [
+		// 复制文件
+		copyFile({
+			sourceDir: 'src/assets',
+			targetDir: 'dist/assets'
+		}),
+
+		// 生成路由配置（uni-app）
+		generateRouter({
+			pagesJsonPath: 'src/pages.json',
+			outputPath: 'src/router.config.ts'
+		}),
+
+		// 生成版本号
+		generateVersion({
+			format: 'datetime',
+			outputType: 'both'
+		}),
+
+		// 注入网站图标
+		injectIco({
+			base: '/assets'
+		})
+	]
+})
+```
+
+### 开发自定义插件
+
+```typescript
+import { BasePlugin, createPluginFactory } from '@meng-xi/vite-plugin'
+import type { Plugin } from 'vite'
+
+interface MyPluginOptions {
+	path: string
+	enabled?: boolean
+	verbose?: boolean
+	errorStrategy?: 'throw' | 'log' | 'ignore'
+}
+
+class MyPlugin extends BasePlugin<MyPluginOptions> {
+	protected getDefaultOptions() {
+		return { path: './default' }
+	}
+
+	protected validateOptions(): void {
+		this.validator.field('path').required().string().validate()
+	}
+
+	protected getPluginName(): string {
+		return 'my-plugin'
+	}
+
+	protected addPluginHooks(plugin: Plugin): void {
+		plugin.buildStart = () => {
+			this.logger.info(`Plugin started with path: ${this.options.path}`)
+		}
+	}
+}
+
+export const myPlugin = createPluginFactory(MyPlugin)
+```
+
+## 内置插件
+
+### copyFile
+
+在 Vite 构建完成后复制文件或目录到指定位置。
+
+| 选项        | 类型    | 默认值 | 描述                 |
+| ----------- | ------- | ------ | -------------------- |
+| sourceDir   | string  | -      | 源目录路径（必填）   |
+| targetDir   | string  | -      | 目标目录路径（必填） |
+| overwrite   | boolean | true   | 是否覆盖现有文件     |
+| recursive   | boolean | true   | 是否递归复制子目录   |
+| incremental | boolean | true   | 是否启用增量复制     |
+
+### generateRouter
+
+根据 uni-app 项目的 `pages.json` 自动生成路由配置文件。
+
+| 选项                 | 类型         | 默认值                 | 描述                          |
+| -------------------- | ------------ | ---------------------- | ----------------------------- |
+| pagesJsonPath        | string       | 'src/pages.json'       | pages.json 文件路径           |
+| outputPath           | string       | 'src/router.config.ts' | 输出文件路径                  |
+| outputFormat         | 'ts' \| 'js' | 'ts'                   | 输出文件格式                  |
+| nameStrategy         | string       | 'camelCase'            | 路由名称策略                  |
+| includeSubPackages   | boolean      | true                   | 是否包含子包路由              |
+| watch                | boolean      | true                   | 是否监听变化自动重新生成      |
+| metaMapping          | object       | -                      | 页面 style 字段到 meta 的映射 |
+| preserveRouteChanges | boolean      | true                   | 是否保留用户对 routes 的修改  |
+
+### generateVersion
+
+在 Vite 构建过程中自动生成版本号。
+
+| 选项       | 类型   | 默认值                | 描述             |
+| ---------- | ------ | --------------------- | ---------------- |
+| format     | string | 'timestamp'           | 版本格式         |
+| outputType | string | 'file'                | 输出类型         |
+| outputFile | string | 'version.json'        | 输出文件路径     |
+| defineName | string | '\_\_APP_VERSION\_\_' | 注入的全局变量名 |
+| prefix     | string | -                     | 版本号前缀       |
+| suffix     | string | -                     | 版本号后缀       |
+
+### injectIco
+
+在 Vite 构建过程中将网站图标链接注入到 HTML 文件的 head 中。
+
+| 选项        | 类型   | 默认值 | 描述                        |
+| ----------- | ------ | ------ | --------------------------- |
+| base        | string | -      | 图标文件的基础路径          |
+| url         | string | -      | 图标的完整 URL              |
+| link        | string | -      | 自定义完整的 link 标签 HTML |
+| icons       | array  | -      | 自定义图标数组              |
+| copyOptions | object | -      | 图标文件复制配置            |
+
+## 更新日志
+
+查看 [GitHub Releases](https://github.com/MengXi-Studio/vite-plugin/releases)
+
+## 贡献指南
+
+欢迎贡献代码！请按以下步骤操作：
+
+1. Fork 本项目
+2. 创建功能分支：`git checkout -b feature/your-feature`
+3. 提交变更：`git commit -m "feat: your feature description"`
+4. 推送分支：`git push origin feature/your-feature`
+5. 创建 Pull Request
+
+## License
+
+[MIT](LICENSE)

package/dist/common/index.cjs

@@ -1 +1 @@
-"use strict";const index=require("../shared/vite-plugin.DrSzERYS.cjs"),validation=require("../shared/vite-plugin.BTKhc7n7.cjs");require("fs"),require("path"),exports.checkSourceExists=index.checkSourceExists,exports.copySourceToTarget=index.copySourceToTarget,exports.ensureTargetDir=index.ensureTargetDir,exports.readDirRecursive=index.readDirRecursive,exports.readFileSync=index.readFileSync,exports.shouldUpdateFile=index.shouldUpdateFile,exports.writeFileContent=index.writeFileContent,exports.Validator=validation.Validator,exports.deepMerge=validation.deepMerge;
+"use strict";const format=require("../shared/vite-plugin.BZsetDCm.cjs"),validation=require("../shared/vite-plugin.IGZeStMa.cjs");require("fs"),require("path"),require("crypto"),exports.checkSourceExists=format.checkSourceExists,exports.copySourceToTarget=format.copySourceToTarget,exports.ensureTargetDir=format.ensureTargetDir,exports.fileExists=format.fileExists,exports.formatDate=format.formatDate,exports.generateRandomHash=format.generateRandomHash,exports.getDateFormatParams=format.getDateFormatParams,exports.padNumber=format.padNumber,exports.parseTemplate=format.parseTemplate,exports.readDirRecursive=format.readDirRecursive,exports.readFileSync=format.readFileSync,exports.runWithConcurrency=format.runWithConcurrency,exports.shouldUpdateFile=format.shouldUpdateFile,exports.stripJsonComments=format.stripJsonComments,exports.toCamelCase=format.toCamelCase,exports.toPascalCase=format.toPascalCase,exports.writeFileContent=format.writeFileContent,exports.Validator=validation.Validator,exports.deepMerge=validation.deepMerge;