minify-pic-cli 1.0.0

package/README.md

@@ -0,0 +1,156 @@
+# TinyPic CLI - 图片批量压缩工具
+
+一个简单易用的图片批量压缩命令行工具，支持 PNG、JPEG、GIF 格式，适合前端和设计师快速优化图片体积。
+
+## 功能特性
+
+- 🖼️ 支持多种图片格式：PNG、JPEG、GIF
+- 📁 批量处理目录及子目录中的所有图片
+- ⚙️ 可自定义压缩质量和参数
+- 🚫 支持排除指定目录
+- 📊 显示压缩前后文件大小对比
+- 🎯 保持原有目录结构
+
+## 安装
+
+### 全局安装
+
+```bash
+# 使用 pnpm 安装
+pnpm install -g tinypic-cli
+
+# 或使用 npm
+npm install -g tinypic-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")
+  -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 -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. **输出目录**：默认输出到 `./output` 目录，会自动创建
+3. **目录结构**：压缩后会保持原有的目录结构
+4. **大文件处理**：对于大文件，压缩可能需要一些时间
+5. **权限问题**：确保对目标目录有写入权限
+
+## 技术栈
+
+- **Node.js**: 运行环境
+- **Sharp**: 高性能图片处理库
+- **Commander.js**: 命令行参数解析
+- **Readline**: 用户交互
+
+## 开发
+
+```bash
+# 安装依赖
+pnpm install
+
+# 运行开发版本
+node index.js
+
+# 构建
+pnpm run build
+```
+
+## 许可证
+
+ISC
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+## 更新日志
+
+### v1.0.0
+- 初始版本发布
+- 支持 PNG、JPEG、GIF 格式压缩
+- 命令行参数支持
+- 批量处理功能

package/index.js

@@ -0,0 +1,162 @@
+#!/usr/bin/env node
+const fs = require("fs");
+const path = require("path");
+const sharp = require("sharp");
+const readline = require("readline");
+const { Command } = require("commander");
+
+// 默认配置参数
+const DEFAULT_CONFIG = {
+  targetDir: process.cwd(), // 需要压缩的目录(可包含子目录)
+  outputDir: path.join(process.cwd(), "output"), // 输出目录
+  quality: 80, // 压缩质量 0 - 100
+  gifColours: 128, // GIF调色板最大数量
+  blackDirs: ["no"], // 排除的子文件夹名称
+};
+
+// 询问用户是否继续
+function askUserToContinue() {
+  return new Promise((resolve) => {
+    const rl = readline.createInterface({
+      input: process.stdin,
+      output: process.stdout,
+    });
+    console.log(`当前目录路径为: ${process.cwd()}`);
+    rl.question("是否需要压缩当前目录的所有图片？Y/N：", (answer) => {
+      rl.close();
+      resolve(answer.trim().toLowerCase() === "y");
+    });
+  });
+}
+
+// 获取文件大小（带单位，自动转换MB/KB）
+function getFileSizeWithUnit(filePath) {
+  const stats = fs.statSync(filePath);
+  const sizeInBytes = stats.size;
+  const sizeInMB = sizeInBytes / 1024 / 1024;
+  if (sizeInMB >= 1) {
+    return sizeInMB.toFixed(2) + "MB";
+  } else {
+    const sizeInKB = sizeInBytes / 1024;
+    if (sizeInKB < 0.01 && sizeInBytes > 0) {
+      return "<0.01KB";
+    }
+    return sizeInKB.toFixed(2) + "KB";
+  }
+}
+
+// 压缩单张图片
+async function compressImage(filePath, config, baseDir = config.targetDir) {
+  const beforeSize = getFileSizeWithUnit(filePath);
+  sharp.cache(false);
+
+  const ext = path.extname(filePath).toLowerCase();
+  let sharpInstance;
+
+  switch (ext) {
+    case ".png":
+      sharpInstance = sharp(filePath).png({ quality: config.quality });
+      break;
+    case ".jpg":
+    case ".jpeg":
+      sharpInstance = sharp(filePath).jpeg({ quality: config.quality });
+      break;
+    case ".gif":
+      sharpInstance = sharp(filePath, {
+        animated: true,
+        limitInputPixels: false,
+      }).gif({ colours: config.gifColours });
+      break;
+    default:
+      throw new Error(`不支持的文件类型: ${ext}`);
+  }
+
+  // 保持目录结构
+  const relativePath = path.relative(baseDir, filePath);
+  const outputFilePath = path.join(config.outputDir, relativePath);
+  const outputFileDir = path.dirname(outputFilePath);
+
+  try {
+    if (!fs.existsSync(outputFileDir)) {
+      fs.mkdirSync(outputFileDir, { recursive: true });
+    }
+    const buffer = await sharpInstance.toBuffer();
+    fs.writeFileSync(outputFilePath, buffer);
+    fs.chmodSync(outputFilePath, 0o646);
+    const afterSize = getFileSizeWithUnit(outputFilePath);
+    console.log(
+      `压缩完成 [大小变化: ${beforeSize} ---->>>> ${afterSize}] ${outputFilePath}`
+    );
+  } catch (error) {
+    console.error(`压缩出错: ${outputFilePath}`, error);
+  }
+}
+
+// 递归压缩目录下所有图片
+async function compressFiles(dir, config, baseDir = config.targetDir) {
+  const files = fs.readdirSync(dir);
+
+  for (const file of files) {
+    const filePath = path.join(dir, file);
+    const stat = fs.statSync(filePath);
+
+    // 跳过 output 目录
+    if (filePath === config.outputDir) {
+      console.log(`跳过的目录: ${filePath}（为输出目录）`);
+      continue;
+    }
+
+    if (stat.isDirectory()) {
+      if (!config.blackDirs.includes(file)) {
+        await compressFiles(filePath, config, baseDir);
+      } else {
+        console.log(`跳过的目录: ${filePath}`);
+      }
+    } else if (/\.(png|jpe?g|gif)$/i.test(filePath)) {
+      await compressImage(filePath, config, baseDir);
+    }
+  }
+}
+
+// commander命令行包装
+const program = new Command();
+
+program
+  .name("mpic")
+  .description("图片批量压缩工具")
+  .option("-d, --dir <dir>", "需要压缩的目录", DEFAULT_CONFIG.targetDir)
+  .option("-o, --output <output>", "输出目录", DEFAULT_CONFIG.outputDir)
+  .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)
+  .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),
+      quality: parseInt(options.quality, 10),
+      gifColours: parseInt(options.gifColours, 10),
+      blackDirs: Array.isArray(options.blackDirs) ? options.blackDirs : [options.blackDirs],
+    };
+
+    let shouldContinue = options.yes;
+    if (!shouldContinue) {
+      shouldContinue = await askUserToContinue();
+    }
+    if (!shouldContinue) {
+      console.log("已取消操作。");
+      process.exit(0);
+    }
+
+    const inputDir = config.targetDir;
+    compressFiles(inputDir, config, inputDir)
+      .then(() => {
+        console.log("压缩任务全部完成，已输出至", config.outputDir);
+      })
+      .catch((err) => {
+        console.error("压缩文件时出错:", err);
+      });
+  });
+
+program.parse(process.argv);

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "minify-pic-cli",
+  "version": "1.0.0",
+  "description": "一个简单易用的图片批量压缩命令行工具，支持 PNG、JPEG、GIF 格式，适合前端和设计师快速优化图片体积。",
+  "main": "index.js",
+  "bin": {
+    "mpic": "./index.js"
+  },
+  "scripts": {
+    "build": "node ./index.js"
+  },
+  "keywords": [
+    "图片压缩",
+    "命令行工具",
+    "image",
+    "compress",
+    "cli",
+    "sharp"
+  ],
+  "author": "kevin031",
+  "license": "ISC",
+  "dependencies": {
+    "commander": "^14.0.0",
+    "sharp": "^0.33.5"
+  }
+}