@meng-xi/vite-plugin 0.1.4 → 0.1.6

package/README-en.md

@@ -15,10 +15,10 @@
 
 ## Features
 
-- **Ready to Use** - 11 practical plugins covering build progress, bundle analysis & compression, file copying, environment variable validation, route generation, version management, HTML injection, favicon management,
-  global Loading, and more
+- **Ready to Use** - 12 practical plugins covering auto-import, build progress, bundle analysis & compression, file copying, environment variable validation, route generation, version management, HTML injection, favicon
+  management, global Loading, and more
 - **Plugin Development Framework** - Exports core components like BasePlugin, Logger, and Validator to quickly build custom Vite plugins
-- **Common Utility Library** - Built-in Common utility modules supporting on-demand sub-path imports
+- **Common Utility Library** - Built-in 6 Common utility modules supporting on-demand sub-path imports
 - **Type Safe** - Complete TypeScript type definitions with configuration validators
 - **On-demand Import** - Supports sub-path exports to reduce bundle size
 
@@ -41,10 +41,11 @@ pnpm add @meng-xi/vite-plugin -D
 
 ```typescript
 import { defineConfig } from 'vite'
-import { buildProgress, bundleAnalyzer, compressAssets, copyFile, envGuard, generateRouter, generateVersion, versionUpdateChecker, htmlInject, faviconManager, loadingManager } from '@meng-xi/vite-plugin'
+import { autoImport, buildProgress, bundleAnalyzer, compressAssets, copyFile, envGuard, generateRouter, generateVersion, versionUpdateChecker, htmlInject, faviconManager, loadingManager } from '@meng-xi/vite-plugin'
 
 export default defineConfig({
 	plugins: [
+		autoImport({ imports: { vue: ['ref', 'reactive', 'computed'] }, dts: 'src/auto-imports.d.ts' }),
 		buildProgress(),
 		bundleAnalyzer({ outputFormat: 'both' }),
 		compressAssets({ algorithm: 'gzip' }),
@@ -64,13 +65,14 @@ export default defineConfig({
 
 | Plugin                                                                                                     | Description                                                                                                                           |
 | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
+| [autoImport](https://mengxi-studio.github.io/vite-plugin/en/plugins/auto-import.html)                      | Auto-inject import statements with preset mappings, directory scanning, and Vue template auto-import                                  |
 | [buildProgress](https://mengxi-studio.github.io/vite-plugin/en/plugins/build-progress.html)                | Real-time terminal build progress bar, supports bar / spinner / minimal                                                               |
 | [bundleAnalyzer](https://mengxi-studio.github.io/vite-plugin/en/plugins/bundle-analyzer.html)              | Bundle volume analysis with JSON/HTML reports, gzip calculation, threshold alerts, and build diff                                     |
 | [compressAssets](https://mengxi-studio.github.io/vite-plugin/en/plugins/compress-assets.html)              | Asset compression with gzip / brotli / both, concurrent compression and statistics report                                             |
 | [copyFile](https://mengxi-studio.github.io/vite-plugin/en/plugins/copy-file.html)                          | Copy files or directories after build, supports incremental copying                                                                   |
-| [envGuard](https://mengxi-studio.github.io/vite-plugin/en/plugins/)                                        | Environment variable validation with type checking, range validation, custom rules and runtime guard                                  |
+| [envGuard](https://mengxi-studio.github.io/vite-plugin/en/plugins/env-guard.html)                          | Environment variable validation with type checking, range validation, custom rules and runtime guard                                  |
 | [faviconManager](https://mengxi-studio.github.io/vite-plugin/en/plugins/favicon-manager.html)              | Manage website favicon link injection and file copying, supports string shorthand config                                              |
-| [generateRouter](https://mengxi-studio.github.io/vite-plugin/en/plugins/generate-router.html)              | Auto-generate route config from pages.json (uni-app)                                                                                  |
+| [generateRouter](https://mengxi-studio.github.io/vite-plugin/en/plugins/generate-router.html)              | Auto-generate route config and type declarations from pages.json (uni-app)                                                            |
 | [generateVersion](https://mengxi-studio.github.io/vite-plugin/en/plugins/generate-version.html)            | Auto-generate version numbers with file output and global variable injection                                                          |
 | [htmlInject](https://mengxi-studio.github.io/vite-plugin/en/plugins/html-inject.html)                      | HTML content injection with multiple positions, selector targeting, conditional injection, template variables, and security filtering |
 | [loadingManager](https://mengxi-studio.github.io/vite-plugin/en/plugins/loading-manager.html)              | Global Loading state management with request interception, debounce, transition animations, and white-screen Loading                  |
@@ -130,22 +132,33 @@ export const myPlugin = createPluginFactory(MyPlugin)
 Built-in general-purpose utility function library, organized by functional modules, supporting on-demand sub-path imports.
 
 ```typescript
-import { formatFileSize } from '@meng-xi/vite-plugin/common/format'
-import { scanDirectory } from '@meng-xi/vite-plugin/common/fs'
-import { calculateGzipSize } from '@meng-xi/vite-plugin/common/compress'
+// Formatting: date params, template variable replacement, file size, date formatting
+import { getDateFormatParams, parseTemplate, formatDate, formatFileSize } from '@meng-xi/vite-plugin/common/format'
+
+// File system: file copy, directory scan, safe write, change detection
+import { copySourceToTarget, scanDirectory, writeFileSyncSafely, shouldUpdateFileContent } from '@meng-xi/vite-plugin/common/fs'
+
+// HTML: tag injection, content sanitization, attribute escaping
+import { injectBeforeTag, injectHeadAndBody, sanitizeContent, escapeHtmlAttr } from '@meng-xi/vite-plugin/common/html'
+
+// Script generation: callback function wrapping
+import { makeCallback } from '@meng-xi/vite-plugin/common/script'
+
+// Terminal UI: ANSI color codes
+import { ANSI } from '@meng-xi/vite-plugin/common/ui'
+
+// Validation: chain validator, common validation functions
+import { Validator, validateGlobalName, validateNoScriptInTemplate } from '@meng-xi/vite-plugin/common/validation'
 ```
 
-| Sub-path                                                                                     | Description             |
-| -------------------------------------------------------------------------------------------- | ----------------------- |
-| [`common/compress`](https://mengxi-studio.github.io/vite-plugin/en/common/compress.html)     | Compression utilities   |
-| [`common/format`](https://mengxi-studio.github.io/vite-plugin/en/common/format.html)         | Formatting utilities    |
-| [`common/fs`](https://mengxi-studio.github.io/vite-plugin/en/common/fs.html)                 | File system utilities   |
-| [`common/html`](https://mengxi-studio.github.io/vite-plugin/en/common/html.html)             | HTML injection utils    |
-| [`common/object`](https://mengxi-studio.github.io/vite-plugin/en/common/object.html)         | Object operation utils  |
-| [`common/path`](https://mengxi-studio.github.io/vite-plugin/en/common/path.html)             | Path handling utils     |
-| [`common/script`](https://mengxi-studio.github.io/vite-plugin/en/common/script.html)         | Script generation utils |
-| [`common/ui`](https://mengxi-studio.github.io/vite-plugin/en/common/)                        | Terminal UI utils       |
-| [`common/validation`](https://mengxi-studio.github.io/vite-plugin/en/common/validation.html) | Validation utilities    |
+| Sub-path                                                                                     | Description                                                                                         |
+| -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
+| [`common/format`](https://mengxi-studio.github.io/vite-plugin/en/common/format.html)         | Date param extraction, template variable replacement `{{key}}`, date formatting `{YYYY}`, file size |
+| [`common/fs`](https://mengxi-studio.github.io/vite-plugin/en/common/fs.html)                 | File/directory copy, directory scan, sync safe write, file change detection                         |
+| [`common/html`](https://mengxi-studio.github.io/vite-plugin/en/common/html.html)             | HTML tag injection, dual-zone injection, content sanitization, HTML attribute value escaping        |
+| [`common/script`](https://mengxi-studio.github.io/vite-plugin/en/common/script.html)         | Callback body wrapping into safe function expressions (with try-catch)                              |
+| [`common/ui`](https://mengxi-studio.github.io/vite-plugin/en/common/ui.html)                 | Terminal ANSI color code constants                                                                  |
+| [`common/validation`](https://mengxi-studio.github.io/vite-plugin/en/common/validation.html) | Chain-style config validator, global name validation, script detection, callback field validation   |
 
 ## Sub-path Exports
 
@@ -157,6 +170,7 @@ import { calculateGzipSize } from '@meng-xi/vite-plugin/common/compress'
 | `@meng-xi/vite-plugin/plugins`                        | All plugins                          |
 | `@meng-xi/vite-plugin/common`                         | All utility functions                |
 | `@meng-xi/vite-plugin/common/*`                       | Utility sub-modules                  |
+| `@meng-xi/vite-plugin/plugins/auto-import`            | autoImport plugin                    |
 | `@meng-xi/vite-plugin/plugins/build-progress`         | buildProgress plugin                 |
 | `@meng-xi/vite-plugin/plugins/bundle-analyzer`        | bundleAnalyzer plugin                |
 | `@meng-xi/vite-plugin/plugins/compress-assets`        | compressAssets plugin                |

package/README.md

@@ -15,9 +15,9 @@
 
 ## 特性
 
-- **开箱即用** - 11 个实用插件，覆盖构建进度、产物分析与压缩、文件复制、环境变量校验、路由生成、版本管理、HTML 注入、图标管理、全局 Loading 等场景
+- **开箱即用** - 12 个实用插件，覆盖自动导入、构建进度、产物分析与压缩、文件复制、环境变量校验、路由生成、版本管理、HTML 注入、图标管理、全局 Loading 等场景
 - **插件开发框架** - 导出 BasePlugin、Logger、Validator 等核心组件，快速构建自定义 Vite 插件
-- **通用工具库** - 内置 Common 工具模块，支持按需子路径导入
+- **通用工具库** - 内置 6 大 Common 工具模块，支持按需子路径导入
 - **类型安全** - 完整 TypeScript 类型定义与配置验证器
 - **按需导入** - 支持子路径导出，减少打包体积
 
@@ -40,10 +40,11 @@ pnpm add @meng-xi/vite-plugin -D
 
 ```typescript
 import { defineConfig } from 'vite'
-import { buildProgress, bundleAnalyzer, compressAssets, copyFile, envGuard, generateRouter, generateVersion, versionUpdateChecker, htmlInject, faviconManager, loadingManager } from '@meng-xi/vite-plugin'
+import { autoImport, buildProgress, bundleAnalyzer, compressAssets, copyFile, envGuard, generateRouter, generateVersion, versionUpdateChecker, htmlInject, faviconManager, loadingManager } from '@meng-xi/vite-plugin'
 
 export default defineConfig({
 	plugins: [
+		autoImport({ imports: { vue: ['ref', 'reactive', 'computed'] }, dts: 'src/auto-imports.d.ts' }),
 		buildProgress(),
 		bundleAnalyzer({ outputFormat: 'both' }),
 		compressAssets({ algorithm: 'gzip' }),
@@ -63,13 +64,14 @@ export default defineConfig({
 
 | 插件                                                                                                    | 说明                                                                  |
 | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| [autoImport](https://mengxi-studio.github.io/vite-plugin/plugins/auto-import.html)                      | 自动注入 import 语句，支持预设映射、目录扫描和 Vue 模板自动导入       |
 | [buildProgress](https://mengxi-studio.github.io/vite-plugin/plugins/build-progress.html)                | 终端实时构建进度条，支持 bar / spinner / minimal                      |
 | [bundleAnalyzer](https://mengxi-studio.github.io/vite-plugin/plugins/bundle-analyzer.html)              | 构建产物体积分析，支持 JSON/HTML 报告、gzip 计算、阈值告警和构建对比  |
 | [compressAssets](https://mengxi-studio.github.io/vite-plugin/plugins/compress-assets.html)              | 构建产物压缩，支持 gzip / brotli / both，并发压缩和统计报告           |
 | [copyFile](https://mengxi-studio.github.io/vite-plugin/plugins/copy-file.html)                          | 构建完成后复制文件或目录，支持增量复制                                |
-| [envGuard](https://mengxi-studio.github.io/vite-plugin/plugins/)                                        | 环境变量校验，支持类型检查、范围验证、自定义规则和运行时守卫          |
+| [envGuard](https://mengxi-studio.github.io/vite-plugin/plugins/env-guard.html)                          | 环境变量校验，支持类型检查、范围验证、自定义规则和运行时守卫          |
 | [faviconManager](https://mengxi-studio.github.io/vite-plugin/plugins/favicon-manager.html)              | 管理网站图标链接注入和文件复制，支持字符串简写配置                    |
-| [generateRouter](https://mengxi-studio.github.io/vite-plugin/plugins/generate-router.html)              | 根据 pages.json 自动生成路由配置（uni-app）                           |
+| [generateRouter](https://mengxi-studio.github.io/vite-plugin/plugins/generate-router.html)              | 根据 pages.json 自动生成路由配置与类型声明（uni-app）                 |
 | [generateVersion](https://mengxi-studio.github.io/vite-plugin/plugins/generate-version.html)            | 自动生成版本号，支持文件输出和全局变量注入                            |
 | [htmlInject](https://mengxi-studio.github.io/vite-plugin/plugins/html-inject.html)                      | HTML 内容注入，支持多种位置、选择器定位、条件注入、模板变量和安全过滤 |
 | [loadingManager](https://mengxi-studio.github.io/vite-plugin/plugins/loading-manager.html)              | 全局 Loading 状态管理，支持请求拦截、防抖、过渡动画和白屏 Loading     |
@@ -129,22 +131,33 @@ export const myPlugin = createPluginFactory(MyPlugin)
 内置通用工具函数库，按功能模块组织，支持子路径按需导入。
 
 ```typescript
-import { formatFileSize } from '@meng-xi/vite-plugin/common/format'
-import { scanDirectory } from '@meng-xi/vite-plugin/common/fs'
-import { calculateGzipSize } from '@meng-xi/vite-plugin/common/compress'
+// 格式化：日期参数、模板变量替换、文件大小、日期格式化
+import { getDateFormatParams, parseTemplate, formatDate, formatFileSize } from '@meng-xi/vite-plugin/common/format'
+
+// 文件系统：文件复制、目录扫描、安全写入、变更检测
+import { copySourceToTarget, scanDirectory, writeFileSyncSafely, shouldUpdateFileContent } from '@meng-xi/vite-plugin/common/fs'
+
+// HTML：标签注入、内容消毒、属性转义
+import { injectBeforeTag, injectHeadAndBody, sanitizeContent, escapeHtmlAttr } from '@meng-xi/vite-plugin/common/html'
+
+// 脚本生成：回调函数包装
+import { makeCallback } from '@meng-xi/vite-plugin/common/script'
+
+// 终端 UI：ANSI 颜色码
+import { ANSI } from '@meng-xi/vite-plugin/common/ui'
+
+// 参数验证：链式验证器、通用校验函数
+import { Validator, validateGlobalName, validateNoScriptInTemplate } from '@meng-xi/vite-plugin/common/validation'
 ```
 
-| 子路径                                                                                    | 描述          |
-| ----------------------------------------------------------------------------------------- | ------------- |
-| [`common/compress`](https://mengxi-studio.github.io/vite-plugin/common/compress.html)     | 压缩算法工具  |
-| [`common/format`](https://mengxi-studio.github.io/vite-plugin/common/format.html)         | 格式化工具    |
-| [`common/fs`](https://mengxi-studio.github.io/vite-plugin/common/fs.html)                 | 文件系统工具  |
-| [`common/html`](https://mengxi-studio.github.io/vite-plugin/common/html.html)             | HTML 注入工具 |
-| [`common/object`](https://mengxi-studio.github.io/vite-plugin/common/object.html)         | 对象操作工具  |
-| [`common/path`](https://mengxi-studio.github.io/vite-plugin/common/path.html)             | 路径处理工具  |
-| [`common/script`](https://mengxi-studio.github.io/vite-plugin/common/script.html)         | 脚本生成工具  |
-| [`common/ui`](https://mengxi-studio.github.io/vite-plugin/common/)                        | 终端 UI 工具  |
-| [`common/validation`](https://mengxi-studio.github.io/vite-plugin/common/validation.html) | 参数验证工具  |
+| 子路径                                                                                    | 描述                                                                      |
+| ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| [`common/format`](https://mengxi-studio.github.io/vite-plugin/common/format.html)         | 日期参数提取、模板变量替换 `{{key}}`、日期格式化 `{YYYY}`、文件大小格式化 |
+| [`common/fs`](https://mengxi-studio.github.io/vite-plugin/common/fs.html)                 | 文件/目录复制、目录扫描、同步安全写入、文件变更检测                       |
+| [`common/html`](https://mengxi-studio.github.io/vite-plugin/common/html.html)             | HTML 标签注入、双区域注入、内容安全消毒、HTML 属性值转义                  |
+| [`common/script`](https://mengxi-studio.github.io/vite-plugin/common/script.html)         | 回调函数体包装为安全的函数表达式（含 try-catch）                          |
+| [`common/ui`](https://mengxi-studio.github.io/vite-plugin/common/ui.html)                 | 终端 ANSI 颜色码常量                                                      |
+| [`common/validation`](https://mengxi-studio.github.io/vite-plugin/common/validation.html) | 链式配置验证器、全局名称校验、脚本检测、回调字段校验                      |
 
 ## 子路径导出
 
@@ -156,6 +169,7 @@ import { calculateGzipSize } from '@meng-xi/vite-plugin/common/compress'
 | `@meng-xi/vite-plugin/plugins`                        | 所有插件                  |
 | `@meng-xi/vite-plugin/common`                         | 所有工具函数              |
 | `@meng-xi/vite-plugin/common/*`                       | 各工具子模块              |
+| `@meng-xi/vite-plugin/plugins/auto-import`            | autoImport 插件           |
 | `@meng-xi/vite-plugin/plugins/build-progress`         | buildProgress 插件        |
 | `@meng-xi/vite-plugin/plugins/bundle-analyzer`        | bundleAnalyzer 插件       |
 | `@meng-xi/vite-plugin/plugins/compress-assets`        | compressAssets 插件       |

package/dist/common/format/index.cjs

@@ -1 +1 @@
-"use strict";const crypto=require("crypto"),a=require("node:path");function _interopDefaultCompat(e){return e&&typeof e=="object"&&"default"in e?e.default:e}const a__default=_interopDefaultCompat(a);function padNumber(e,t=2){return e.toString().padStart(t,"0")}function generateRandomHash(e=8){const t=Math.max(1,Math.min(64,e));return crypto.randomBytes(Math.ceil(t/2)).toString("hex").slice(0,t)}function getDateFormatParams(e=new Date){return{YYYY:e.getFullYear().toString(),YY:e.getFullYear().toString().slice(-2),MM:padNumber(e.getMonth()+1),DD:padNumber(e.getDate()),HH:padNumber(e.getHours()),mm:padNumber(e.getMinutes()),ss:padNumber(e.getSeconds()),SSS:padNumber(e.getMilliseconds(),3),timestamp:e.getTime().toString()}}function formatDate(e,t){const r=getDateFormatParams(e);let o=t;for(const[n,s]of Object.entries(r))o=o.replace(new RegExp(`\\{${n}\\}`,"g"),s);return o}function parseTemplate(e,t){let r=e;for(const[o,n]of Object.entries(t))r=r.replace(new RegExp(`\\{${o}\\}`,"g"),n);return r}function toCamelCase(e,t=/[/-]/){return e.replace(/^\/+/,"").split(t).filter(Boolean).map((r,o)=>o===0?r.toLowerCase():r.charAt(0).toUpperCase()+r.slice(1).toLowerCase()).join("")}function toPascalCase(e,t=/[/-]/){return e.replace(/^\/+/,"").split(t).filter(Boolean).map(r=>r.charAt(0).toUpperCase()+r.slice(1).toLowerCase()).join("")}function stripJsonComments(e){return e.replace(/\/\/.*$/gm,"").replace(/\/\*[\s\S]*?\*\//g,"")}function escapeHtmlAttr(e){return e.replace(/&/g,"&amp;").replace(/"/g,"&quot;").replace(/</g,"&lt;").replace(/>/g,"&gt;")}function formatFileSize(e){return e<1024?`${e}B`:e<1024*1024?`${(e/1024).toFixed(1)}KB`:`${(e/(1024*1024)).toFixed(2)}MB`}function getExtension(e){return a__default.extname(e).toLowerCase()}exports.escapeHtmlAttr=escapeHtmlAttr,exports.formatDate=formatDate,exports.formatFileSize=formatFileSize,exports.generateRandomHash=generateRandomHash,exports.getDateFormatParams=getDateFormatParams,exports.getExtension=getExtension,exports.padNumber=padNumber,exports.parseTemplate=parseTemplate,exports.stripJsonComments=stripJsonComments,exports.toCamelCase=toCamelCase,exports.toPascalCase=toPascalCase;
+"use strict";function t(e,r=2){return e.toString().padStart(r,"0")}function getDateFormatParams(e=new Date){return{YYYY:e.getFullYear().toString(),YY:e.getFullYear().toString().slice(-2),MM:t(e.getMonth()+1),DD:t(e.getDate()),HH:t(e.getHours()),mm:t(e.getMinutes()),ss:t(e.getSeconds()),SSS:t(e.getMilliseconds(),3),timestamp:e.getTime().toString()}}function parseTemplate(e,r){let o=e;for(const[n,a]of Object.entries(r)){const s=n.replace(/[.*+?^${}()|[\]\\]/g,"\\$&"),i=a.replace(/\$/g,"$$$$");o=o.replace(new RegExp(`\\{\\{${s}\\}\\}`,"g"),i)}return o}function formatDate(e,r){const o=getDateFormatParams(e);let n=r;for(const[a,s]of Object.entries(o))n=n.replace(new RegExp(`\\{${a}\\}`,"g"),s);return n}function formatFileSize(e){return e<1024?`${e}B`:e<1024*1024?`${(e/1024).toFixed(1)}KB`:`${(e/(1024*1024)).toFixed(2)}MB`}exports.formatDate=formatDate,exports.formatFileSize=formatFileSize,exports.getDateFormatParams=getDateFormatParams,exports.parseTemplate=parseTemplate;

package/dist/common/format/index.d.cts

@@ -22,34 +22,6 @@ interface DateFormatOptions {
     timestamp: string;
 }
 
-/**
- * 数字补零格式化
- *
- * @param num 要格式化的数字
- * @param length 目标长度
- * @returns 补零后的字符串
- *
- * @example
- * ```typescript
- * padNumber(5, 2)  // '05'
- * padNumber(12, 3) // '012'
- * padNumber(123, 2) // '123'
- * ```
- */
-declare function padNumber(num: number, length?: number): string;
-/**
- * 生成随机哈希字符串
- *
- * @param length 哈希长度，范围 1-64
- * @returns 随机哈希字符串
- *
- * @example
- * ```typescript
- * generateRandomHash(8)  // 'a1b2c3d4'
- * generateRandomHash(16) // 'a1b2c3d4e5f6g7h8'
- * ```
- */
-declare function generateRandomHash(length?: number): string;
 /**
  * 获取日期格式化参数
  *
@@ -64,93 +36,39 @@ declare function generateRandomHash(length?: number): string;
  */
 declare function getDateFormatParams(date?: Date): DateFormatOptions;
 /**
- * 格式化日期
+ * 替换模板字符串中的变量占位符
  *
- * @param date 日期对象
- * @param format 格式模板
- * @returns 格式化后的日期字符串
- *
- * @example
- * ```typescript
- * formatDate(new Date(), '{YYYY}-{MM}-{DD}')         // '2026-02-03'
- * formatDate(new Date(), '{YYYY}{MM}{DD}{HH}{mm}{ss}') // '20260203153000'
- * formatDate(new Date(), '{YYYY}.{MM}.{DD}')         // '2026.02.03'
- * ```
- */
-declare function formatDate(date: Date, format: string): string;
-/**
- * 解析模板字符串，替换占位符
+ * @param template - 包含 `{{key}}` 占位符的模板字符串
+ * @param values - 占位符键值映射，支持合并多组变量（后者覆盖前者）
+ * @returns 替换占位符后的字符串
  *
- * @param template 模板字符串
- * @param values 占位符值映射
- * @returns 替换后的字符串
+ * @description 将模板中的 `{{key}}` 占位符替换为对应的值。
+ * 键名中的正则特殊字符会被自动转义，值中的 `$` 也会被安全处理。
  *
  * @example
  * ```typescript
- * parseTemplate('{name}-{version}', { name: 'app', version: '1.0.0' })
- * // 'app-1.0.0'
- * ```
- */
-declare function parseTemplate(template: string, values: Record<string, string>): string;
-/**
- * 将字符串转换为驼峰命名（camelCase）
- *
- * @param str 输入字符串
- * @param separators 分隔符正则，默认为斜杠和横线
- * @returns 驼峰命名字符串
+ * parseTemplate('Hello {{name}}!', { name: 'World' })
+ * // 'Hello World!'
  *
- * @example
- * ```typescript
- * toCamelCase('pages/user/profile')  // 'pagesUserProfile'
- * toCamelCase('user-profile-page')   // 'userProfilePage'
- * toCamelCase('/pages/index')        // 'pagesIndex'
- * ```
- */
-declare function toCamelCase(str: string, separators?: RegExp): string;
-/**
- * 将字符串转换为帕斯卡命名（PascalCase）
- *
- * @param str 输入字符串
- * @param separators 分隔符正则，默认为斜杠和横线
- * @returns 帕斯卡命名字符串
- *
- * @example
- * ```typescript
- * toPascalCase('pages/user/profile')  // 'PagesUserProfile'
- * toPascalCase('user-profile-page')   // 'UserProfilePage'
- * toPascalCase('/pages/index')        // 'PagesIndex'
+ * parseTemplate('{{YYYY}}-{{MM}}-{{DD}}', getDateFormatParams())
+ * // '2026-06-06'
  * ```
  */
-declare function toPascalCase(str: string, separators?: RegExp): string;
-/**
- * 移除 JSON 字符串中的注释
- *
- * @param jsonString 包含注释的 JSON 字符串
- * @returns 移除注释后的 JSON 字符串
- *
- * @example
- * ```typescript
- * stripJsonComments('{\n  // comment\n  "name": "test"\n}')
- * // '{\n  "name": "test"\n}'
- * ```
- */
-declare function stripJsonComments(jsonString: string): string;
+declare function parseTemplate(template: string, values: Record<string, string>): string;
 /**
- * 转义 HTML 属性值中的特殊字符，防止 XSS 注入
+ * 格式化日期字符串
  *
- * @param str - 需要转义的字符串
- * @returns 转义后的安全字符串
+ * @param date - 日期对象
+ * @param format - 格式字符串，支持 `{YYYY}`、`{MM}`、`{DD}`、`{HH}`、`{mm}`、`{ss}` 等占位符
+ * @returns 格式化后的日期字符串
  *
  * @example
  * ```typescript
- * escapeHtmlAttr('hello "world"')
- * // 'hello &quot;world&quot;'
- *
- * escapeHtmlAttr('<script>alert(1)</script>')
- * // '&lt;script&gt;alert(1)&lt;/script&gt;'
+ * formatDate(new Date(), '{YYYY}-{MM}-{DD}T{HH}:{mm}:{ss}')
+ * // '2026-06-06T15:30:00'
  * ```
  */
-declare function escapeHtmlAttr(str: string): string;
+declare function formatDate(date: Date, format: string): string;
 /**
  * 将字节数格式化为人类可读的文件大小字符串
  *
@@ -170,19 +88,6 @@ declare function escapeHtmlAttr(str: string): string;
  * ```
  */
 declare function formatFileSize(bytes: number): string;
-/**
- * 获取文件扩展名
- *
- * @param {string} filePath - 文件路径
- * @returns {string} 小写的文件扩展名（如 '.js'）
- *
- * @example
- * ```typescript
- * getExtension('dist/app.js')  // '.js'
- * getExtension('dist/style.CSS') // '.css'
- * ```
- */
-declare function getExtension(filePath: string): string;
 
-export { escapeHtmlAttr, formatDate, formatFileSize, generateRandomHash, getDateFormatParams, getExtension, padNumber, parseTemplate, stripJsonComments, toCamelCase, toPascalCase };
+export { formatDate, formatFileSize, getDateFormatParams, parseTemplate };
 export type { DateFormatOptions };

package/dist/common/format/index.d.mts

@@ -22,34 +22,6 @@ interface DateFormatOptions {
     timestamp: string;
 }
 
-/**
- * 数字补零格式化
- *
- * @param num 要格式化的数字
- * @param length 目标长度
- * @returns 补零后的字符串
- *
- * @example
- * ```typescript
- * padNumber(5, 2)  // '05'
- * padNumber(12, 3) // '012'
- * padNumber(123, 2) // '123'
- * ```
- */
-declare function padNumber(num: number, length?: number): string;
-/**
- * 生成随机哈希字符串
- *
- * @param length 哈希长度，范围 1-64
- * @returns 随机哈希字符串
- *
- * @example
- * ```typescript
- * generateRandomHash(8)  // 'a1b2c3d4'
- * generateRandomHash(16) // 'a1b2c3d4e5f6g7h8'
- * ```
- */
-declare function generateRandomHash(length?: number): string;
 /**
  * 获取日期格式化参数
  *
@@ -64,93 +36,39 @@ declare function generateRandomHash(length?: number): string;
  */
 declare function getDateFormatParams(date?: Date): DateFormatOptions;
 /**
- * 格式化日期
+ * 替换模板字符串中的变量占位符
  *
- * @param date 日期对象
- * @param format 格式模板
- * @returns 格式化后的日期字符串
- *
- * @example
- * ```typescript
- * formatDate(new Date(), '{YYYY}-{MM}-{DD}')         // '2026-02-03'
- * formatDate(new Date(), '{YYYY}{MM}{DD}{HH}{mm}{ss}') // '20260203153000'
- * formatDate(new Date(), '{YYYY}.{MM}.{DD}')         // '2026.02.03'
- * ```
- */
-declare function formatDate(date: Date, format: string): string;
-/**
- * 解析模板字符串，替换占位符
+ * @param template - 包含 `{{key}}` 占位符的模板字符串
+ * @param values - 占位符键值映射，支持合并多组变量（后者覆盖前者）
+ * @returns 替换占位符后的字符串
  *
- * @param template 模板字符串
- * @param values 占位符值映射
- * @returns 替换后的字符串
+ * @description 将模板中的 `{{key}}` 占位符替换为对应的值。
+ * 键名中的正则特殊字符会被自动转义，值中的 `$` 也会被安全处理。
  *
  * @example
  * ```typescript
- * parseTemplate('{name}-{version}', { name: 'app', version: '1.0.0' })
- * // 'app-1.0.0'
- * ```
- */
-declare function parseTemplate(template: string, values: Record<string, string>): string;
-/**
- * 将字符串转换为驼峰命名（camelCase）
- *
- * @param str 输入字符串
- * @param separators 分隔符正则，默认为斜杠和横线
- * @returns 驼峰命名字符串
+ * parseTemplate('Hello {{name}}!', { name: 'World' })
+ * // 'Hello World!'
  *
- * @example
- * ```typescript
- * toCamelCase('pages/user/profile')  // 'pagesUserProfile'
- * toCamelCase('user-profile-page')   // 'userProfilePage'
- * toCamelCase('/pages/index')        // 'pagesIndex'
- * ```
- */
-declare function toCamelCase(str: string, separators?: RegExp): string;
-/**
- * 将字符串转换为帕斯卡命名（PascalCase）
- *
- * @param str 输入字符串
- * @param separators 分隔符正则，默认为斜杠和横线
- * @returns 帕斯卡命名字符串
- *
- * @example
- * ```typescript
- * toPascalCase('pages/user/profile')  // 'PagesUserProfile'
- * toPascalCase('user-profile-page')   // 'UserProfilePage'
- * toPascalCase('/pages/index')        // 'PagesIndex'
+ * parseTemplate('{{YYYY}}-{{MM}}-{{DD}}', getDateFormatParams())
+ * // '2026-06-06'
  * ```
  */
-declare function toPascalCase(str: string, separators?: RegExp): string;
-/**
- * 移除 JSON 字符串中的注释
- *
- * @param jsonString 包含注释的 JSON 字符串
- * @returns 移除注释后的 JSON 字符串
- *
- * @example
- * ```typescript
- * stripJsonComments('{\n  // comment\n  "name": "test"\n}')
- * // '{\n  "name": "test"\n}'
- * ```
- */
-declare function stripJsonComments(jsonString: string): string;
+declare function parseTemplate(template: string, values: Record<string, string>): string;
 /**
- * 转义 HTML 属性值中的特殊字符，防止 XSS 注入
+ * 格式化日期字符串
  *
- * @param str - 需要转义的字符串
- * @returns 转义后的安全字符串
+ * @param date - 日期对象
+ * @param format - 格式字符串，支持 `{YYYY}`、`{MM}`、`{DD}`、`{HH}`、`{mm}`、`{ss}` 等占位符
+ * @returns 格式化后的日期字符串
  *
  * @example
  * ```typescript
- * escapeHtmlAttr('hello "world"')
- * // 'hello &quot;world&quot;'
- *
- * escapeHtmlAttr('<script>alert(1)</script>')
- * // '&lt;script&gt;alert(1)&lt;/script&gt;'
+ * formatDate(new Date(), '{YYYY}-{MM}-{DD}T{HH}:{mm}:{ss}')
+ * // '2026-06-06T15:30:00'
  * ```
  */
-declare function escapeHtmlAttr(str: string): string;
+declare function formatDate(date: Date, format: string): string;
 /**
  * 将字节数格式化为人类可读的文件大小字符串
  *
@@ -170,19 +88,6 @@ declare function escapeHtmlAttr(str: string): string;
  * ```
  */
 declare function formatFileSize(bytes: number): string;
-/**
- * 获取文件扩展名
- *
- * @param {string} filePath - 文件路径
- * @returns {string} 小写的文件扩展名（如 '.js'）
- *
- * @example
- * ```typescript
- * getExtension('dist/app.js')  // '.js'
- * getExtension('dist/style.CSS') // '.css'
- * ```
- */
-declare function getExtension(filePath: string): string;
 
-export { escapeHtmlAttr, formatDate, formatFileSize, generateRandomHash, getDateFormatParams, getExtension, padNumber, parseTemplate, stripJsonComments, toCamelCase, toPascalCase };
+export { formatDate, formatFileSize, getDateFormatParams, parseTemplate };
 export type { DateFormatOptions };