minify-pic-cli 1.0.2 → 1.1.0

package/README.md

@@ -1,149 +1,174 @@
-# Minify Pic CLI - 图片批量压缩工具
+# Minify Pic CLI - Batch Image Compression Tool
 
-一个简单易用的图片批量压缩命令行工具，支持 PNG、JPEG、GIF 格式，适合前端和设计师快速优化图片体积。
+English | [简体中文](./README.zh-CN.md)
 
-## 功能特性
+A simple and easy-to-use command-line tool for batch image compression, supporting PNG, JPEG, and GIF formats. Perfect for frontend developers and designers to quickly optimize image file sizes.
 
-- 🖼️ 支持多种图片格式：PNG、JPEG、GIF
-- 📁 批量处理目录及子目录中的所有图片
-- ⚙️ 可自定义压缩质量和参数
-- 🚫 支持排除指定目录
-- 📊 显示压缩前后文件大小对比
-- 🎯 保持原有目录结构
+## Features
 
-## 安装
+- 🖼️ Support multiple image formats: PNG, JPEG, GIF
+- 📁 Batch process all images in directories and subdirectories
+- ⚙️ Customizable compression quality and parameters
+- 🚫 Support for excluding specified directories
+- 📊 Display file size comparison before and after compression
+- 🎯 Maintain original directory structure
+- ⚡ Support skip confirmation for automation
+- 🔄 Support in-place compression to replace original files
 
-### 全局安装
+## Installation
+
+### Global Installation
 
 ```bash
-# 使用 pnpm 安装
+# Install using pnpm
 pnpm install -g minify-pic-cli
 
-# 或使用 npm
+# Or using npm
 npm install -g minify-pic-cli
 ```
 
-## 使用方法
+## Usage
 
-### 基本用法
+### Basic Usage
 
 ```bash
-# 压缩当前目录的所有图片
+# Compress all images in current directory
 mpic
 
-# 或直接运行
+# Or run directly
 node index.js
 ```
 
-### 命令行选项
+### Command Line Options
 
 ```bash
-mpic [选项]
-
-选项:
-  -d, --dir <dir>              需要压缩的目录 (默认: 当前目录)
-  -o, --output <output>        输出目录 (默认: ./output)
-  -q, --quality <quality>      压缩质量 0-100 (默认: 80)
-  -g, --gif-colours <colours>  GIF调色板最大数量 2-256 (默认: 128)
-  -b, --black-dirs <dirs>      排除的子文件夹名称，逗号分隔 (默认: "no")
-  -v, --version                显示版本号
-  -h, --help                   显示帮助信息
+mpic [options]
+
+Options:
+  -d, --dir <dir>              Directory to compress (default: current directory)
+  -o, --output <output>        Output directory (default: ./output)
+  -q, --quality <quality>      Compression quality 0-100 (default: 80)
+  -g, --gif-colours <colours>  GIF palette maximum colors 2-256 (default: 128)
+  -b, --black-dirs <dirs>      Exclude subdirectories, comma-separated (default: "no")
+  -y, --yes                    Skip confirmation and start compression directly
+  -r, --replace                In-place compression, replace original files
+  -v, --version                Display version number
+  -h, --help                   Display help information
 ```
 
-### 使用示例
+### Usage Examples
 
 ```bash
-# 压缩指定目录的图片，输出到 compressed 文件夹
+# Compress images in specified directory, output to compressed folder
 mpic -d ./images -o ./compressed
 
-# 设置压缩质量为 90
+# Set compression quality to 90
 mpic -q 90
 
-# 排除 node_modules 和 .git 目录
+# Exclude node_modules and .git directories
 mpic -b "node_modules,.git"
 
-# 设置 GIF 调色板为 64 色
+# Set GIF palette to 64 colors
 mpic -g 64
 
-# 组合使用多个选项
+# Skip confirmation prompt, start compression automatically
+mpic -y
+
+# In-place compression to replace original files (no new directory)
+mpic -r
+
+# Skip confirmation + in-place replace (recommended for automation)
+mpic -y -r
+
+# In-place replace + custom compression quality
+mpic -y -r -q 90
+
+# Combine multiple options
 mpic -d ./src/assets -o ./dist/assets -q 85 -b "node_modules,.git"
 ```
 
-## 支持的图片格式
+## Supported Image Formats
 
-- **PNG**: 支持透明度，适合图标和简单图形
-- **JPEG**: 适合照片和复杂图像
-- **GIF**: 支持动画，可调整调色板颜色数量
+- **PNG**: Supports transparency, suitable for icons and simple graphics
+- **JPEG**: Suitable for photos and complex images
+- **GIF**: Supports animation, adjustable palette colors
 
-## 配置说明
+## Configuration
 
-### 压缩质量 (quality)
-- 范围：0-100
-- 默认：80
-- 数值越高，质量越好，文件越大
-- 建议：80-90 为最佳平衡点
+### Compression Quality (quality)
+- Range: 0-100
+- Default: 80
+- Higher value = better quality, larger file size
+- Recommended: 80-90 for best balance
 
-### GIF 调色板颜色数 (gif-colours)
-- 范围：2-256
-- 默认：128
-- 颜色数越少，文件越小，但可能影响视觉效果
-- 建议：64-128 为常用范围
+### GIF Palette Colors (gif-colours)
+- Range: 2-256
+- Default: 128
+- Fewer colors = smaller file size, may affect visual quality
+- Recommended: 64-128 for common use
 
-### 排除目录 (black-dirs)
-- 支持多个目录，用逗号分隔
-- 默认排除 "no" 目录
-- 常用排除目录：`node_modules,.git,dist,build`
+### Exclude Directories (black-dirs)
+- Support multiple directories, comma-separated
+- Default exclude: "no" directory
+- Common exclude directories: `node_modules,.git,dist,build`
 
-## 输出说明
+## Output Information
 
-工具会在控制台显示：
-- 当前工作目录
-- 压缩进度和结果
-- 文件大小变化对比
-- 最终输出目录
+The tool displays in console:
+- Current working directory
+- Compression progress and results
+- File size comparison
+- Final output directory
 
-示例输出：
+Example output:
 ```
-当前目录路径为: /path/to/your/project
-是否需要压缩当前目录的所有图片？Y/N：y
-压缩完成 [大小变化: 2.5MB ---->>>> 1.2MB] /path/to/output/image1.jpg
-压缩完成 [大小变化: 800KB ---->>>> 400KB] /path/to/output/image2.png
-压缩任务全部完成，已输出至 /path/to/output
+Current directory path: /path/to/your/project
+Do you need to compress all images in the current directory? Y/N: y
+Compression complete [Size change: 2.5MB ---->>>> 1.2MB] /path/to/output/image1.jpg
+Compression complete [Size change: 800KB ---->>>> 400KB] /path/to/output/image2.png
+All compression tasks completed, output to /path/to/output
 ```
 
-## 注意事项
+## Important Notes
 
-1. **备份原文件**：工具会创建新的压缩文件，不会覆盖原文件
-2. **输出目录**：默认输出到 `./output` 目录，会自动创建
-3. **目录结构**：压缩后会保持原有的目录结构
-4. **大文件处理**：对于大文件，压缩可能需要一些时间
-5. **权限问题**：确保对目标目录有写入权限
+1. **Backup Original Files**: Default mode creates new compressed files in output directory without overwriting originals
+2. **In-Place Replace Mode**: Using `-r` parameter will directly replace original files. Use with caution and backup important files first
+3. **Output Directory**: Default output to `./output` directory, automatically created (not created when using `-r`)
+4. **Directory Structure**: Maintains original directory structure after compression
+5. **Large File Processing**: Compression of large files may take some time
+6. **Permission Issues**: Ensure write permissions for target directories
+7. **Automation Scripts**: For CI/CD or automation scripts, use `-y` parameter to skip interactive confirmation
 
-## 技术栈
+## Tech Stack
 
-- **Node.js**: 运行环境
-- **Sharp**: 高性能图片处理库
-- **Commander.js**: 命令行参数解析
-- **Readline**: 用户交互
+- **Node.js**: Runtime environment
+- **Sharp**: High-performance image processing library
+- **Commander.js**: Command-line argument parsing
+- **Readline**: User interaction
 
-## 开发
+## Development
 
 ```bash
-# 安装依赖
+# Install dependencies
 pnpm install
 
-# 运行开发版本
+# Run development version
 node index.js
 ```
 
-## 许可证
+## License
 
 ISC
 
-## 更新日志
+## Changelog
+
+### v1.0.3
+- Added `-y, --yes` parameter: Skip confirmation prompt for automation support
+- Added `-r, --replace` parameter: In-place compression to replace original files
+- Improved user experience with more flexible usage options
 
 ### v1.0.2
-- 初始版本发布
-- 支持 PNG、JPEG、GIF 格式压缩
-- 命令行参数支持
-- 批量处理功能
+- Initial release
+- Support PNG, JPEG, GIF format compression
+- Command-line parameter support
+- Batch processing functionality

package/README.zh-CN.md

@@ -0,0 +1,174 @@
+# Minify Pic CLI - 图片批量压缩工具
+
+简体中文 | [English](./README.md)
+
+一个简单易用的图片批量压缩命令行工具，支持 PNG、JPEG、GIF 格式，适合前端和设计师快速优化图片体积。
+
+## 功能特性
+
+- 🖼️ 支持多种图片格式：PNG、JPEG、GIF
+- 📁 批量处理目录及子目录中的所有图片
+- ⚙️ 可自定义压缩质量和参数
+- 🚫 支持排除指定目录
+- 📊 显示压缩前后文件大小对比
+- 🎯 保持原有目录结构
+- ⚡ 支持跳过确认，自动化执行
+- 🔄 支持原地压缩替换原文件
+
+## 安装
+
+### 全局安装
+
+```bash
+# 使用 pnpm 安装
+pnpm install -g minify-pic-cli
+
+# 或使用 npm
+npm install -g minify-pic-cli
+```
+
+## 使用方法
+
+### 基本用法
+
+```bash
+# 压缩当前目录的所有图片
+mpic
+
+# 或直接运行
+node index.js
+```
+
+### 命令行选项
+
+```bash
+mpic [选项]
+
+选项:
+  -d, --dir <dir>              需要压缩的目录 (默认: 当前目录)
+  -o, --output <output>        输出目录 (默认: ./output)
+  -q, --quality <quality>      压缩质量 0-100 (默认: 80)
+  -g, --gif-colours <colours>  GIF调色板最大数量 2-256 (默认: 128)
+  -b, --black-dirs <dirs>      排除的子文件夹名称，逗号分隔 (默认: "no")
+  -y, --yes                    跳过确认，直接开始压缩
+  -r, --replace                原地压缩替换原文件，不输出到新目录
+  -v, --version                显示版本号
+  -h, --help                   显示帮助信息
+```
+
+### 使用示例
+
+```bash
+# 压缩指定目录的图片，输出到 compressed 文件夹
+mpic -d ./images -o ./compressed
+
+# 设置压缩质量为 90
+mpic -q 90
+
+# 排除 node_modules 和 .git 目录
+mpic -b "node_modules,.git"
+
+# 设置 GIF 调色板为 64 色
+mpic -g 64
+
+# 跳过确认提示，自动开始压缩
+mpic -y
+
+# 原地压缩替换原文件（不创建新目录）
+mpic -r
+
+# 跳过确认 + 原地替换（自动化场景推荐）
+mpic -y -r
+
+# 原地替换 + 自定义压缩质量
+mpic -y -r -q 90
+
+# 组合使用多个选项
+mpic -d ./src/assets -o ./dist/assets -q 85 -b "node_modules,.git"
+```
+
+## 支持的图片格式
+
+- **PNG**: 支持透明度，适合图标和简单图形
+- **JPEG**: 适合照片和复杂图像
+- **GIF**: 支持动画，可调整调色板颜色数量
+
+## 配置说明
+
+### 压缩质量 (quality)
+- 范围：0-100
+- 默认：80
+- 数值越高，质量越好，文件越大
+- 建议：80-90 为最佳平衡点
+
+### GIF 调色板颜色数 (gif-colours)
+- 范围：2-256
+- 默认：128
+- 颜色数越少，文件越小，但可能影响视觉效果
+- 建议：64-128 为常用范围
+
+### 排除目录 (black-dirs)
+- 支持多个目录，用逗号分隔
+- 默认排除 "no" 目录
+- 常用排除目录：`node_modules,.git,dist,build`
+
+## 输出说明
+
+工具会在控制台显示：
+- 当前工作目录
+- 压缩进度和结果
+- 文件大小变化对比
+- 最终输出目录
+
+示例输出：
+```
+当前目录路径为: /path/to/your/project
+是否需要压缩当前目录的所有图片？Y/N：y
+压缩完成 [大小变化: 2.5MB ---->>>> 1.2MB] /path/to/output/image1.jpg
+压缩完成 [大小变化: 800KB ---->>>> 400KB] /path/to/output/image2.png
+压缩任务全部完成，已输出至 /path/to/output
+```
+
+## 注意事项
+
+1. **备份原文件**：默认模式会创建新的压缩文件到输出目录，不会覆盖原文件
+2. **原地替换模式**：使用 `-r` 参数会直接替换原文件，请谨慎使用，建议先备份重要文件
+3. **输出目录**：默认输出到 `./output` 目录，会自动创建（使用 `-r` 时不会创建）
+4. **目录结构**：压缩后会保持原有的目录结构
+5. **大文件处理**：对于大文件，压缩可能需要一些时间
+6. **权限问题**：确保对目标目录有写入权限
+7. **自动化脚本**：在 CI/CD 或自动化脚本中，建议使用 `-y` 参数跳过交互确认
+
+## 技术栈
+
+- **Node.js**: 运行环境
+- **Sharp**: 高性能图片处理库
+- **Commander.js**: 命令行参数解析
+- **Readline**: 用户交互
+
+## 开发
+
+```bash
+# 安装依赖
+pnpm install
+
+# 运行开发版本
+node index.js
+```
+
+## 许可证
+
+ISC
+
+## 更新日志
+
+### v1.0.3
+- 新增 `-y, --yes` 参数：跳过确认提示，支持自动化执行
+- 新增 `-r, --replace` 参数：原地压缩替换原文件
+- 优化用户体验，提供更多灵活的使用方式
+
+### v1.0.2
+- 初始版本发布
+- 支持 PNG、JPEG、GIF 格式压缩
+- 命令行参数支持
+- 批量处理功能

package/index.js

@@ -71,10 +71,20 @@ async function compressImage(filePath, config, baseDir = config.targetDir) {
       throw new Error(`不支持的文件类型: ${ext}`);
   }
 
-  // 保持目录结构
-  const relativePath = path.relative(baseDir, filePath);
-  const outputFilePath = path.join(config.outputDir, relativePath);
-  const outputFileDir = path.dirname(outputFilePath);
+  // 原地替换模式或输出到新目录
+  let outputFilePath;
+  let outputFileDir;
+  
+  if (config.replace) {
+    // 原地替换：使用临时文件
+    outputFilePath = filePath + '.tmp';
+    outputFileDir = path.dirname(outputFilePath);
+  } else {
+    // 保持目录结构输出到新目录
+    const relativePath = path.relative(baseDir, filePath);
+    outputFilePath = path.join(config.outputDir, relativePath);
+    outputFileDir = path.dirname(outputFilePath);
+  }
 
   try {
     if (!fs.existsSync(outputFileDir)) {
@@ -83,12 +93,27 @@ async function compressImage(filePath, config, baseDir = config.targetDir) {
     const buffer = await sharpInstance.toBuffer();
     fs.writeFileSync(outputFilePath, buffer);
     fs.chmodSync(outputFilePath, 0o646);
-    const afterSize = getFileSizeWithUnit(outputFilePath);
-    console.log(
-      `压缩完成 [大小变化: ${beforeSize} ---->>>> ${afterSize}] ${outputFilePath}`
-    );
+    
+    // 如果是原地替换模式，将临时文件重命名为原文件
+    if (config.replace) {
+      fs.unlinkSync(filePath);
+      fs.renameSync(outputFilePath, filePath);
+      const afterSize = getFileSizeWithUnit(filePath);
+      console.log(
+        `压缩完成 [大小变化: ${beforeSize} ---->>>> ${afterSize}] ${filePath}`
+      );
+    } else {
+      const afterSize = getFileSizeWithUnit(outputFilePath);
+      console.log(
+        `压缩完成 [大小变化: ${beforeSize} ---->>>> ${afterSize}] ${outputFilePath}`
+      );
+    }
   } catch (error) {
-    console.error(`压缩出错: ${outputFilePath}`, error);
+    console.error(`压缩出错: ${config.replace ? filePath : outputFilePath}`, error);
+    // 如果原地替换失败，清理临时文件
+    if (config.replace && fs.existsSync(outputFilePath)) {
+      fs.unlinkSync(outputFilePath);
+    }
   }
 }
 
@@ -100,8 +125,8 @@ async function compressFiles(dir, config, baseDir = config.targetDir) {
     const filePath = path.join(dir, file);
     const stat = fs.statSync(filePath);
 
-    // 跳过 output 目录
-    if (filePath === config.outputDir) {
+    // 跳过 output 目录（非原地替换模式）
+    if (!config.replace && filePath === config.outputDir) {
       console.log(`跳过的目录: ${filePath}（为输出目录）`);
       continue;
     }
@@ -129,15 +154,18 @@ program
   .option("-q, --quality <quality>", "压缩质量(0-100)", String(DEFAULT_CONFIG.quality))
   .option("-g, --gif-colours <colours>", "GIF调色板最大数量(2-256)", String(DEFAULT_CONFIG.gifColours))
   .option("-b, --black-dirs <dirs>", "排除的子文件夹名称(逗号分隔)", val => val.split(","), DEFAULT_CONFIG.blackDirs)
+  .option("-y, --yes", "跳过确认，直接开始压缩")
+  .option("-r, --replace", "原地压缩替换原文件，不输出到新目录")
   .version(require('./package.json').version, '-v, --version', '显示版本号')
   .action(async (options) => {
     // 合并配置
     const config = {
       targetDir: path.resolve(process.cwd(), options.dir),
-      outputDir: path.resolve(process.cwd(), options.output),
+      outputDir: options.replace ? null : path.resolve(process.cwd(), options.output),
       quality: parseInt(options.quality, 10),
       gifColours: parseInt(options.gifColours, 10),
       blackDirs: Array.isArray(options.blackDirs) ? options.blackDirs : [options.blackDirs],
+      replace: options.replace || false,
     };
 
     let shouldContinue = options.yes;
@@ -152,7 +180,11 @@ program
     const inputDir = config.targetDir;
     compressFiles(inputDir, config, inputDir)
       .then(() => {
-        console.log("压缩任务全部完成，已输出至", config.outputDir);
+        if (config.replace) {
+          console.log("压缩任务全部完成，已原地替换所有图片");
+        } else {
+          console.log("压缩任务全部完成，已输出至", config.outputDir);
+        }
       })
       .catch((err) => {
         console.error("压缩文件时出错:", err);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "minify-pic-cli",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "一个简单易用的图片批量压缩命令行工具，支持 PNG、JPEG、GIF 格式，适合前端和设计师快速优化图片体积。",
   "main": "index.js",
   "bin": {