vertigostudio/imgbot-compress

Imgbot

镜像概述和主要用途

Imgbot是一款针对GitHub仓库的图像优化工具，它能够自动爬取仓库中的所有图像文件，应用无损压缩算法减小文件大小，同时保持图像的尺寸和质量不变。压缩完成后，Imgbot会提交拉取请求，帮助用户轻松优化仓库中的图像资源。

!截图

核心功能和特性

• 无损压缩：默认采用无损压缩算法，确保图像质量和尺寸不受影响的同时减小文件体积
• 灵活配置：支持通过.imgbotconfig文件进行高级配置，满足不同场景需求
• 调度控制：可设置压缩频率（每日、每周或每月），避免频繁拉取请求
• 文件过滤：支持按扩展名、文件名或文件夹路径忽略特定图像文件
• 压缩策略选择：可选择启用有损压缩算法以获得更大压缩比
• Wiki支持：可配置是否同时压缩Wiki仓库中的图像
• 阈值控制：可设置最小压缩大小阈值，限制拉取请求频率
• 自定义PR内容：付费计划用户可自定义拉取请求的标题和正文内容

使用场景和适用范围

• GitHub仓库维护者需要优化图像资源以减少存储空间占用
• 网站或应用开发者希望减小图像文件大小以提升加载速度
• 需要定期维护大量图像文件的项目团队
• 希望自动化图像优化流程，减少手动操作的场景

配置说明

Imgbot支持通过根目录下的.imgbotconfig JSON文件进行可选配置，适用于更高级的使用场景。以下是配置示例及参数说明：

配置文件示例

json
{
    "schedule": "daily", // daily|weekly|monthly
    "ignoredFiles": [
        "*.jpg",                   // 按扩展名忽略
        "image1.png",              // 按文件名忽略
        "public/special_images/*", // 按文件夹路径忽略
    ],
    "aggressiveCompression": "true", // true|false
    "compressWiki": "true", // true|false
    "minKBReduced": 500, // 设置压缩阈值（默认10KB）
    "prTitle" : "压缩图像", // 设置拉取请求标题
    // 设置拉取请求正文，支持GitHub Markdown格式
    // {optimization_ratio} 显示优化比例信息
    // {optimization_details} 显示优化详情表格
    "prBody" : "优化比例前的文本 {optimization_ratio} 优化比例后的文本 
                优化详情前的文本 {optimization_details} 优化详情后的文本"
}

参数说明

schedule

• 可选
• 接受值：daily|weekly|monthly
• 功能：限制Imgbot提交拉取请求的频率，分别为每日一次、每周一次或每月一次
• 默认行为：当图像需要优化时立即提交拉取请求

ignoredFiles

• 可选
• 接受值：符合Directory.EnumerateFiles()搜索模式的语法
• 功能：通过忽略特定文件来限制Imgbot优化的图像范围
• 使用说明：按文件名忽略时无需路径，按文件夹忽略时需提供从根目录开始的完整路径

aggressiveCompression

• 可选
• 接受值：true|false
• 功能：选择是否启用有损压缩算法
• 默认行为：未设置时使用无损压缩

compressWiki

• 可选
• 接受值：true|false
• 功能：选择是否同时压缩Wiki仓库（例如：https://github.com/用户名/仓库名.wiki.git）
• 默认行为：不压缩Wiki仓库

minKBReduced

• 可选
• 接受值：仅数字（例如："minKBReduced": 500 表示500KB阈值）
• 功能：设置最小压缩大小阈值，用于限制Imgbot打开拉取请求的频率
• 默认值：10（KB）

prTitle

• 可选（仅付费计划可用）
• 接受值：仅字符串（例如："prTitle": "我的标题"）
• 功能：自定义拉取请求标题
• 默认值："[ImgBot] 优化图像"

prBody

• 可选（仅付费计划可用）
• 接受值：仅字符串
• 功能：自定义拉取请求正文，支持GitHub https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax%E6%A0%BC%E5%BC%8F
• 支持两个特殊标签：
  • {optimization_ratio}：显示所有图像的平均优化比例
  • {optimization_details}：显示每个图像的优化详情表格
• 默认值：生成如截图所示的正文内容

贡献

Imgbot的所有代码均在GitHub上开源。我们欢迎对服务、网站和文档的贡献。你可以在以下链接找到本地运行的设置方法以及Imgbot工作原理的详细信息：

[***]

了解更多信息：[***]