@meng-xi/vite-plugin 0.0.3 → 0.0.4

package/README-en.md

@@ -1,150 +1,164 @@
-**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="梦曦工作室 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, and also serves as a complete **Vite Plugin Development Framework**.
+> - 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.
+> - Export core components like BasePlugin, Logger, Validator, allowing developers to build custom plugins based on the same infrastructure.
+
+---
+
+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
+
+#### Using Built-in Plugins
+
+```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'
+		})
+	]
+})
+```
+
+#### Developing Custom Plugins
+
+```typescript
+import { BasePlugin, createPluginFactory, Validator } 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)
+```
+
+## 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.

package/README.md

@@ -1,84 +1,143 @@
-**中文** | [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>
+
+[![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 功能，简化构建过程中的常见任务，提高开发效率
+- **插件开发框架**：导出核心组件如 BasePlugin、Logger、Validator，允许开发者基于相同基础设施构建自定义插件
+- **高度可配置**：所有功能支持详细配置选项，可根据项目需求自定义行为，满足多样化场景
+- **单例日志系统**：统一的日志管理器，支持插件级别的日志控制，便于调试和问题排查
+- **类型安全验证**：强类型配置验证器，确保插件配置正确性，提供完整的 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
+```
+
+## 基本使用
+
+### 使用内置插件
+
+```typescript
+import { defineConfig } from 'vite'
+import { copyFile, injectIco } from '@meng-xi/vite-plugin'
+
+export default defineConfig({
+	plugins: [
+		copyFile({
+			sourceDir: 'src/assets',
+			targetDir: 'dist/assets'
+		}),
+		injectIco({
+			base: '/assets'
+		})
+	]
+})
+```
+
+### 开发自定义插件
+
+```typescript
+import { BasePlugin, createPluginFactory, Validator } 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)
+```
+
+## 更新日志
+
+[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，并等待审核。

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.D6NYITpX.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.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.shouldUpdateFile=format.shouldUpdateFile,exports.writeFileContent=format.writeFileContent,exports.Validator=validation.Validator,exports.deepMerge=validation.deepMerge;