@zhaoshijun/compress 1.3.0 → 1.4.1

package/README.md

@@ -11,7 +11,8 @@
 - ⚙️ **灵活配置**：支持配置文件 (`compress.config.js`)，可精细控制压缩参数。
 - 🛡 **安全可靠**：支持备份原文件，默认不覆盖源文件（CLI 模式输出到指定目录）。
 - 📦 **智能缓存**：Vite 插件基于内容 Hash 缓存，避免重复压缩，提升构建速度。
-- 💧 **水印功能**：支持添加文字水印，可自定义透明度、密度、颜色等参数。
+- 💧 **水印功能**：支持文本水印、图片水印（单个/平铺），可自定义透明度、位置、尺寸等参数。
+- 🔒 **隐私保护**：默认去除图片元数据（拍摄时间、地点等），支持保留元数据选项。
 
 ## 安装
 
@@ -50,13 +51,30 @@ CLI 工具用于批量扫描并压缩本地图片文件。
 | `--backup`        |      | 启用备份模式（将原文件复制为 `.backup`）             |
 | `--dry-run`       |      | 演练模式，仅列出将要处理的文件，不进行实际压缩和写入 |
 | `--quiet`         | `-q` | 静默模式，仅输出错误信息                             |
-| `--watermark`     | `-w` | 启用水印                                             |
-| `--watermark-text <text>` | | 水印文本内容 |
-| `--watermark-opacity <opacity>` | | 水印透明度 (0-1) |
-| `--watermark-density <density>` | | 水印密度 (1-10) |
-| `--watermark-color <color>` | | 水印颜色 (hex 或 rgba) |
+| `--watermark`     | `-w` | 启用水印（使用配置文件中的水印设置）                 |
+| `--keep-metadata` |      | 保留图片元数据（拍摄时间、地点等）                   |
+| `--output <dir>`  | `-o` | 输出目录                                             |
 | `--help`          | `-h` | 显示帮助信息                                         |
 
+### 水印命令选项
+
+| 选项 | 描述 |
+| ---- | ---- |
+| `--watermark-mode <mode>` | 水印模式 (text/image/tiled) (default: "text") |
+| `--watermark-text <text>` | 水印文本 |
+| `--watermark-image <path>` | 水印图片路径 |
+| `--watermark-opacity <opacity>` | 水印透明度 (0-1) |
+| `--watermark-density <density>` | 水印密度 (1-10) |
+| `--watermark-color <color>` | 水印颜色 (hex 或 rgba) |
+| `--watermark-font-size <size>` | 水印字体大小 |
+| `--watermark-width <width>` | 水印图片宽度 |
+| `--watermark-height <height>` | 水印图片高度 |
+| `--watermark-position <position>` | 水印位置 (top-left/top-right/bottom-left/bottom-right/center/custom) |
+| `--watermark-padding <padding>` | 水印边距 |
+| `--watermark-angle <angle>` | 水印倾斜角度 |
+| `--watermark-spacing-x <spacing>` | 水印水平间隔 |
+| `--watermark-spacing-y <spacing>` | 水印垂直间隔 |
+
 ### 示例
 
 ```bash
@@ -66,40 +84,96 @@ npx @zhaoshijun/compress --dry-run
 # 使用指定配置文件并开启静默模式
 npx @zhaoshijun/compress -c ./config/compress.js -q
 
-# 压缩图片并添加水印
+# 压缩图片并添加文本水印
 npx @zhaoshijun/compress -w --watermark-text "Copyright 2024"
 
-# 压缩图片并添加自定义水印
+# 压缩图片并添加自定义文本水印
 npx @zhaoshijun/compress -w --watermark-text "My Watermark" --watermark-opacity 0.3 --watermark-color "#ff0000"
+
+# 压缩图片并添加图片水印
+npx @zhaoshijun/compress -w --watermark-mode image --watermark-image "./logo.png"
+
+# 压缩图片并添加平铺水印
+npx @zhaoshijun/compress -w --watermark-mode tiled --watermark-image "./copyright.png"
+
+# 压缩图片并保留元数据
+npx @zhaoshijun/compress --keep-metadata
+
+# 压缩图片并指定输出目录
+npx @zhaoshijun/compress --output ./compressed
 ```
 
 ## 水印功能
 
+支持三种水印模式：文本水印、单个图片水印、平铺图片水印。
+
 ### 单独添加水印
 
 如果只需要给图片添加水印而不进行压缩，可以使用 `watermark` 命令：
 
 ```bash
-# 给图片添加水印（输出到 ./watermarked 目录）
+# 文本水印
 npx @zhaoshijun/compress watermark --watermark-text "Copyright 2024"
 
-# 自定义水印参数
+# 自定义文本水印参数
 npx @zhaoshijun/compress watermark --watermark-text "Confidential" --watermark-opacity 0.7 --watermark-density 5 --watermark-color "rgba(255,0,0,0.5)"
 
+# 单个图片水印
+npx @zhaoshijun/compress watermark --watermark-mode image --watermark-image "./logo.png"
+
+# 自定义图片水印位置和尺寸
+npx @zhaoshijun/compress watermark --watermark-mode image --watermark-image "./brand-logo.png" --watermark-position bottom-right --watermark-padding 20 --watermark-opacity 1
+
+# 平铺图片水印
+npx @zhaoshijun/compress watermark --watermark-mode tiled --watermark-image "./copyright.png"
+
+# 自定义平铺水印参数
+npx @zhaoshijun/compress watermark --watermark-mode tiled --watermark-image "./copyright.png" --watermark-opacity 0.15 --watermark-width 100 --watermark-height 100 --watermark-angle -30 --watermark-spacing-x 300 --watermark-spacing-y 300
+
 # 指定输出目录
 npx @zhaoshijun/compress watermark --watermark-text "Watermark" --output ./output
 ```
 
 ### 水印参数说明
 
+#### 文本水印参数
+
 | 参数 | 说明 | 默认值 | 范围 |
 | ---- | ---- | ------ | ---- |
+| `mode` | 水印模式 | 'text' | text/image/tiled |
 | `text` | 水印文本内容 | '' | 必填 |
-| `opacity` | 水印透明度 | 0.5 | 0-1 |
+| `opacity` | 水印透明度 | 1 | 0-1 |
 | `density` | 水印密度（平铺数量） | 3 | 1-10 |
 | `color` | 水印颜色 | '#ffffff' | hex 或 rgba |
 | `fontSize` | 水印字体大小 | 24 | 正整数 |
 
+#### 单个图片水印参数
+
+| 参数 | 说明 | 默认值 | 范围 |
+| ---- | ---- | ------ | ---- |
+| `mode` | 水印模式 | 'text' | text/image/tiled |
+| `imagePath` | 水印图片路径 | '' | 必填 |
+| `opacity` | 水印透明度 | 1 | 0-1 |
+| `width` | 水印宽度 | null | 正整数 |
+| `height` | 水印高度 | null | 正整数 |
+| `position` | 水印位置 | 'top-left' | top-left/top-right/bottom-left/bottom-right/center/custom |
+| `padding` | 水印边距 | 10 | 正整数 |
+| `x` | 自定义 X 坐标 | 0 | 正整数 |
+| `y` | 自定义 Y 坐标 | 0 | 正整数 |
+
+#### 平铺图片水印参数
+
+| 参数 | 说明 | 默认值 | 范围 |
+| ---- | ---- | ------ | ---- |
+| `mode` | 水印模式 | 'text' | text/image/tiled |
+| `imagePath` | 水印图片路径 | '' | 必填 |
+| `opacity` | 水印透明度 | 1 | 0-1 |
+| `width` | 水印宽度 | null | 正整数 |
+| `height` | 水印高度 | null | 正整数 |
+| `angle` | 倾斜角度 | -30 | -180 到 180 |
+| `spacingX` | 水平间隔 | 100 | 正整数 |
+| `spacingY` | 垂直间隔 | 100 | 正整数 |
+
 ## Vite 插件
 
 该插件仅在 `vite build` 生产构建模式下生效，会自动压缩项目中引用的图片资源，并替换构建产物中的引用路径。
@@ -222,13 +296,27 @@ module.exports = {
   // [CLI专用] 是否备份原文件
   backup: false,
 
+  // 元数据处理
+  keepMetadata: false, // 是否保留图片元数据（拍摄时间、地点等），默认 false（去除元数据）
+
   // 水印配置
   watermark: {
+    mode: 'text', // 水印模式：text/image/tiled
     text: '', // 水印文本内容，留空则不添加水印
-    opacity: 0.5, // 水印透明度 (0-1)
+    imagePath: '', // 水印图片路径（image/tiled 模式）
+    opacity: 1, // 水印透明度 (0-1)
     density: 3, // 水印密度 (1-10)，数值越大水印越多
     color: '#ffffff', // 水印颜色，支持 hex 或 rgba 格式
-    fontSize: 24 // 水印字体大小
+    fontSize: 24, // 水印字体大小
+    width: null, // 水印图片宽度（image/tiled 模式）
+    height: null, // 水印图片高度（image/tiled 模式）
+    position: 'top-left', // 水印位置（image 模式）：top-left/top-right/bottom-left/bottom-right/center/custom
+    padding: 10, // 水印边距（image 模式）
+    x: 0, // 自定义 X 坐标（position 为 custom 时）
+    y: 0, // 自定义 Y 坐标（position 为 custom 时）
+    angle: -30, // 倾斜角度（tiled 模式）
+    spacingX: 100, // 水平间隔（tiled 模式）
+    spacingY: 100 // 垂直间隔（tiled 模式）
   },
 
   // [Vite插件专用] 配置
@@ -264,6 +352,12 @@ A: 不会。Vite 插件仅在构建过程中处理资源，生成的压缩图片
 **Q: 水印会影响图片质量吗？**
 A: 水印是在图片压缩后添加的，不会影响图片本身的压缩质量。水印的透明度可以通过 `opacity` 参数调整，建议设置为 0.3-0.7 之间以获得最佳效果。
 
+**Q: 支持哪些水印模式？**
+A: 支持三种水印模式：
+- **文本水印**：添加文字水印，可自定义文本、颜色、字体大小等
+- **单个图片水印**：在指定位置添加单个图片水印，支持 6 种预设位置和自定义坐标
+- **平铺图片水印**：在整个图片上平铺水印图片，支持旋转和间隔设置
+
 **Q: 水印密度如何设置？**
 A: 水印密度 `density` 参数控制水印的平铺数量，范围是 1-10。数值越大，水印越密集。默认值为 3，适合大多数场景。
 
@@ -273,6 +367,26 @@ A: 可以。使用 `watermark` 命令可以单独给图片添加水印而不进
 **Q: 水印颜色支持哪些格式？**
 A: 水印颜色支持十六进制格式（如 `#ffffff`）和 RGBA 格式（如 `rgba(255,255,255,0.5)`）。
 
+**Q: 图片水印支持哪些格式？**
+A: 水印图片支持 JPEG、PNG、WebP、GIF、TIFF、SVG 等常见格式。
+
+**Q: 如何去除图片元数据？**
+A: 默认情况下，压缩图片时会自动去除所有元数据（包括拍摄时间、GPS 位置、相机信息等）。如果需要保留元数据，可以使用 `--keep-metadata` 选项或在配置文件中设置 `keepMetadata: true`。
+
+**Q: 去除元数据有什么好处？**
+A: 去除元数据有以下好处：
+- **隐私保护**：防止拍摄时间、地点等敏感信息泄露
+- **文件体积减小**：元数据占用额外空间，去除后文件更小
+- **加载速度提升**：更小的文件加载更快
+- **带宽节省**：减少网络传输数据量
+
+**Q: 什么时候需要保留元数据？**
+A: 以下场景可能需要保留元数据：
+- 摄影作品集：需要保留拍摄参数和版权信息
+- 图库上传：某些图库要求保留元数据
+- 档案管理：需要记录拍摄时间和设备信息
+- 法律要求：某些场景需要保留原始元数据
+
 **Q: 如何选择合适的压缩选项？**
 A: 不同格式有不同的压缩策略：
 

package/bin/compress.js

@@ -29,6 +29,8 @@ program
   .option('--dry-run', '仅列出将处理的文件，不写入磁盘')
   .option('-q, --quiet', '静默模式，仅输出错误')
   .option('-w, --watermark', '启用水印')
+  .option('--keep-metadata', '保留图片元数据（拍摄时间、地点等）')
+  .option('-o, --output <dir>', '输出目录')
   .action(async (options) => {
     try {
       const startTime = Date.now();
@@ -38,6 +40,8 @@ program
       
       // 合并命令行选项
       if (options.backup !== undefined) config.backup = options.backup;
+      if (options.keepMetadata !== undefined) config.keepMetadata = options.keepMetadata;
+      if (options.output !== undefined) config.output = options.output;
       
       // 确定输入源
       // 如果 config.input 未定义，则默认为当前目录 '**/*.{jpg,jpeg,png,webp}'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhaoshijun/compress",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "description": "Image compression CLI and Vite plugin",
   "type": "module",
   "bin": {

package/src/config/defaults.js

@@ -1,6 +1,7 @@
 export const defaultConfig = {
   output: './compressed',
   quality: 88,
+  keepMetadata: false,
   jpegOptions: {
     quality: 88,
     progressive: false,

package/src/core/compressor.js

@@ -127,5 +127,10 @@ export async function compressImage(input, options, filePath) {
       }
   }
 
+  // 如果需要保留元数据
+  if (options.keepMetadata) {
+    instance = instance.withMetadata();
+  }
+
   return instance.toBuffer();
 }