@meng-xi/vite-plugin 0.0.1 → 0.0.3

package/README-en.md

@@ -0,0 +1,150 @@
+**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.

package/README.md

@@ -1,138 +1,84 @@
-# @meng-xi/vite-plugin [![npm](https://img.shields.io/npm/v/@meng-xi/vite-plugin?color=blue)](https://www.npmjs.com/package/@meng-xi/vite-plugin) ![GitHub](https://img.shields.io/github/license/MengXi-Studio/vite-plugin?color=orange)
-
-> - 这是一个为 Vite 提供实用插件的工具包，帮助开发者简化构建流程，提高开发效率。
-> - 扩展 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
-```
-
-### 基本使用
-
-在 Vite 配置文件中引入并使用插件：
-
-```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 { defineConfig } from 'vite'
-import vitePlugin from '@meng-xi/vite-plugin'
-
-export default defineConfig({
-	plugins: [
-		// 复制文件插件
-		vitePlugin.copyFile({
-			sourceDir: 'src/assets',
-			targetDir: 'dist/assets'
-		}),
-
-		// 注入图标插件
-		vitePlugin.injectIco({
-			base: '/assets'
-		})
-	]
-})
-```
-
-## 插件详情
-
-### copyFile 插件
-
-用于在 Vite 构建完成后复制文件或目录到指定位置。
-
-**配置选项**：
-
-- `sourceDir`：源目录路径（必填）
-- `targetDir`：目标目录路径（必填）
-- `overwrite`：是否覆盖已存在的文件，默认为 `true`
-- `recursive`：是否递归复制子目录，默认为 `true`
-- `verbose`：是否输出详细日志，默认为 `true`
-- `enabled`：是否启用插件，默认为 `true`
-
-### injectIco 插件
-
-用于在 Vite 构建过程中注入网站图标链接到 HTML 文件的头部。
-
-**配置选项**：
-
-- `base`：图标文件的基础路径
-- `url`：图标的完整 URL
-- `link`：自定义的完整 link 标签 HTML
-- `icons`：自定义图标数组
-- `verbose`：是否输出详细日志，默认为 `true`
-- `enabled`：是否启用插件，默认为 `true`
-- `copyOptions`：图标文件复制配置
-
-## 贡献
-
-欢迎为 `@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 功能，简化构建过程中的常见任务，提高开发效率
+- **模块化插件架构**：采用模块化设计，插件可单独使用或组合使用，灵活应对不同项目需求
+- **高度可配置**：所有功能支持详细配置选项，可根据项目需求自定义行为，满足多样化场景
+- **环境感知能力**：支持根据构建环境条件执行插件功能，智能控制不同环境下的行为
+- **详细日志输出**：提供可选的详细日志，帮助开发者了解执行过程，便于调试和问题排查
+- **类型安全**：完全使用 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，并等待审核。

package/dist/common/index.cjs

@@ -0,0 +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;

package/dist/common/index.d.cts

@@ -0,0 +1,109 @@
+export { V as Validator } from '../shared/vite-plugin.CiHfwMiN.cjs';
+
+/**
+ * 复制操作的选项接口
+ */
+interface CopyOptions {
+    /**
+     * 是否支持递归复制
+     */
+    recursive: boolean;
+    /**
+     * 是否覆盖同名文件
+     */
+    overwrite: boolean;
+    /**
+     * 是否启用增量复制
+     */
+    incremental?: boolean;
+    /**
+     * 并行处理的最大文件数
+     */
+    parallelLimit?: number;
+    /**
+     * 是否跳过空目录
+     */
+    skipEmptyDirs?: boolean;
+}
+/**
+ * 复制结果接口
+ */
+interface CopyResult {
+    /**
+     * 复制的文件数量
+     */
+    copiedFiles: number;
+    /**
+     * 跳过的文件数量
+     */
+    skippedFiles: number;
+    /**
+     * 复制的目录数量
+     */
+    copiedDirs: number;
+    /**
+     * 总执行时间（毫秒）
+     */
+    executionTime: number;
+}
+
+/**
+ * 检查源文件是否存在
+ * @param sourcePath 源文件路径
+ * @throws 当源文件不存在或无法访问时抛出异常
+ */
+declare function checkSourceExists(sourcePath: string): Promise<void>;
+/**
+ * 创建目标目录
+ * @param targetPath 目标目录路径
+ * @throws 当无法创建目标目录时抛出异常
+ */
+declare function ensureTargetDir(targetPath: string): Promise<void>;
+/**
+ * 读取目录内容
+ * @param dirPath 目录路径
+ * @param recursive 是否递归读取
+ * @returns 文件和目录列表
+ */
+declare function readDirRecursive(dirPath: string, recursive: boolean): Promise<string[]>;
+/**
+ * 检查文件是否需要更新
+ * @param sourceFile 源文件路径
+ * @param targetFile 目标文件路径
+ * @returns 是否需要更新
+ */
+declare function shouldUpdateFile(sourceFile: string, targetFile: string): Promise<boolean>;
+/**
+ * 执行文件复制操作
+ * @param sourcePath 源文件或目录路径
+ * @param targetPath 目标文件或目录路径
+ * @param options 复制选项
+ * @returns 复制结果
+ * @throws 当复制过程中出现错误时抛出异常
+ */
+declare function copySourceToTarget(sourcePath: string, targetPath: string, options: CopyOptions): Promise<CopyResult>;
+/**
+ * 写入文件内容
+ * @param filePath 文件路径
+ * @param content 文件内容
+ * @throws 当写入过程中出现错误时抛出异常
+ */
+declare function writeFileContent(filePath: string, content: string): Promise<void>;
+/**
+ * 同步读取文件内容
+ * @param filePath 文件路径
+ * @returns 文件内容字符串
+ * @throws 当读取过程中出现错误时抛出异常
+ */
+declare function readFileSync(filePath: string): string;
+
+/**
+ * 深度合并对象
+ *
+ * @param target 目标对象
+ * @param sources 源对象列表
+ * @returns 合并后的对象
+ */
+declare function deepMerge<T extends Record<string, any>>(...sources: Partial<T>[]): T;
+
+export { checkSourceExists, copySourceToTarget, deepMerge, ensureTargetDir, readDirRecursive, readFileSync, shouldUpdateFile, writeFileContent };

package/dist/common/index.d.mts

@@ -0,0 +1,109 @@
+export { V as Validator } from '../shared/vite-plugin.CiHfwMiN.mjs';
+
+/**
+ * 复制操作的选项接口
+ */
+interface CopyOptions {
+    /**
+     * 是否支持递归复制
+     */
+    recursive: boolean;
+    /**
+     * 是否覆盖同名文件
+     */
+    overwrite: boolean;
+    /**
+     * 是否启用增量复制
+     */
+    incremental?: boolean;
+    /**
+     * 并行处理的最大文件数
+     */
+    parallelLimit?: number;
+    /**
+     * 是否跳过空目录
+     */
+    skipEmptyDirs?: boolean;
+}
+/**
+ * 复制结果接口
+ */
+interface CopyResult {
+    /**
+     * 复制的文件数量
+     */
+    copiedFiles: number;
+    /**
+     * 跳过的文件数量
+     */
+    skippedFiles: number;
+    /**
+     * 复制的目录数量
+     */
+    copiedDirs: number;
+    /**
+     * 总执行时间（毫秒）
+     */
+    executionTime: number;
+}
+
+/**
+ * 检查源文件是否存在
+ * @param sourcePath 源文件路径
+ * @throws 当源文件不存在或无法访问时抛出异常
+ */
+declare function checkSourceExists(sourcePath: string): Promise<void>;
+/**
+ * 创建目标目录
+ * @param targetPath 目标目录路径
+ * @throws 当无法创建目标目录时抛出异常
+ */
+declare function ensureTargetDir(targetPath: string): Promise<void>;
+/**
+ * 读取目录内容
+ * @param dirPath 目录路径
+ * @param recursive 是否递归读取
+ * @returns 文件和目录列表
+ */
+declare function readDirRecursive(dirPath: string, recursive: boolean): Promise<string[]>;
+/**
+ * 检查文件是否需要更新
+ * @param sourceFile 源文件路径
+ * @param targetFile 目标文件路径
+ * @returns 是否需要更新
+ */
+declare function shouldUpdateFile(sourceFile: string, targetFile: string): Promise<boolean>;
+/**
+ * 执行文件复制操作
+ * @param sourcePath 源文件或目录路径
+ * @param targetPath 目标文件或目录路径
+ * @param options 复制选项
+ * @returns 复制结果
+ * @throws 当复制过程中出现错误时抛出异常
+ */
+declare function copySourceToTarget(sourcePath: string, targetPath: string, options: CopyOptions): Promise<CopyResult>;
+/**
+ * 写入文件内容
+ * @param filePath 文件路径
+ * @param content 文件内容
+ * @throws 当写入过程中出现错误时抛出异常
+ */
+declare function writeFileContent(filePath: string, content: string): Promise<void>;
+/**
+ * 同步读取文件内容
+ * @param filePath 文件路径
+ * @returns 文件内容字符串
+ * @throws 当读取过程中出现错误时抛出异常
+ */
+declare function readFileSync(filePath: string): string;
+
+/**
+ * 深度合并对象
+ *
+ * @param target 目标对象
+ * @param sources 源对象列表
+ * @returns 合并后的对象
+ */
+declare function deepMerge<T extends Record<string, any>>(...sources: Partial<T>[]): T;
+
+export { checkSourceExists, copySourceToTarget, deepMerge, ensureTargetDir, readDirRecursive, readFileSync, shouldUpdateFile, writeFileContent };