picgo-plugin-img-avif 1.0.1

package/License

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Carbene Hu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,18 @@
+## picgo-plugin-img-avif
+
+一个使用 `sharp` 库进行图片压缩和格式转换的 PicGo 插件。可以将图片转换为 `jpeg`、`png`、`webp`、`avif` 格式，并可选择按质量进行压缩。在 `beforeUploadPlugins` 生命周期中工作。
+
+### 功能特点
+
+- **格式转换**：支持原图（不改变）、`jpeg`、`png`、`webp`、`avif` 格式
+- **质量配置**：可设置压缩质量（0–100）
+- **自动重命名**：格式变化时自动修改文件扩展名
+- **可靠上传**：使用缓冲区上传确保可靠性
+
+## 安装方法
+
+在 PicGo 插件商店搜索 `img-avif` 并安装。
+
+### 许可证
+
+详见 `License` 文件。

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "picgo-plugin-img-avif",
+  "version": "1.0.1",
+  "description": "一个压缩并转换图片格式的 PicGo 插件",
+  "main": "src/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/liyao52033/picgo-plugin-img-avif",
+  "scripts": {
+    "publish": "npm publish"
+  },
+  "keywords": [
+    "picgo",
+    "picgo-gui-plugin",
+    "picgo-plugin"
+  ],
+  "author": "liyao52033",
+  "license": "MIT",
+  "dependencies": {
+    "sharp": "^0.34.5"
+  }
+}

package/src/index.js

@@ -0,0 +1,140 @@
+const sharp = require('sharp')
+const path = require('path')
+
+// Plugin configuration schema
+const config = (ctx) => {
+  let userConfig = ctx.getConfig('picgo-plugin-converter')
+  if (!userConfig) {
+    userConfig = {}
+  }
+  return [
+    {
+      name: 'format',
+      type: 'list',
+      alias: '目标格式',
+      default: userConfig.format || 'original',
+      message: 'Select output format',
+      choices: [
+        { name: '原格式', value: 'original' },
+        { name: 'JPEG', value: 'jpeg' },
+        { name: 'PNG', value: 'png' },
+        { name: 'WebP', value: 'webp' },
+        { name: 'AVIF', value: 'avif' } 
+      ]
+    },
+    {
+      name: 'quality',
+      type: 'input',
+      alias: '压缩质量(0-100)',
+      default: userConfig.quality || '80',
+      message: 'Compression quality (0-100)',
+      validate: function (val) {
+        if (val >= 0 && val <= 100) return true
+        return 'Please enter a number between 0 and 100'
+      }
+    },
+    {
+      name: 'lossless',
+      type: 'confirm',
+      alias: 'WebP/AVIF无损压缩',
+      default: userConfig.lossless || false,
+      message: 'Enable lossless compression for WebP/AVIF? (May increase file size)' // 修改提示文案
+    }
+  ]
+}
+
+// Core handler function
+const handle = async (ctx) => {
+  // Get user configuration
+  const userConfig = ctx.getConfig('picgo-plugin-converter') || {}
+  const targetFormat = userConfig.format || 'original'
+  const quality = parseInt(userConfig.quality) || 80
+  const lossless = userConfig.lossless || false
+  // 1. 新增 AVIF 到支持的输入格式列表
+  const VALID_INPUT_FORMATS = ['.jpg', '.jpeg', '.png', '.webp', '.bmp', '.tiff', '.avif']
+
+  const output = ctx.output
+
+  // Iterate over files to upload
+  await Promise.all(output.map(async (item) => {
+    // Simple format filter: only process images
+    if (!item.buffer && !item.base64Image) return // Skip if no content
+    const ext = path.extname(item.fileName).toLowerCase()
+    // We only process common image formats for now
+    if (!VALID_INPUT_FORMATS.includes(ext)) {
+      ctx.log.warn(`File extension ${ext} is not supported for conversion. Skipping ${item.fileName}.`)
+      return
+    }
+
+    try {
+      // Instantiate sharp
+      // PicGo's Transformer outputs a Buffer by default, but may also be base64
+      let image = sharp(item.buffer || Buffer.from(item.base64Image, 'base64'))
+
+      let finalFormat = targetFormat
+      ctx.log.info(`[Convertor] Processing ${item.fileName}: target format = ${targetFormat}, quality = ${quality}`)
+
+      // If 'original' is selected, keep original format; still specify format for compression
+      if (finalFormat === 'original') {
+        // sharp requires explicit format names, e.g., 'jpeg' not 'jpg'
+        finalFormat = ext.replace('.', '')
+        if (finalFormat === 'jpg') finalFormat = 'jpeg'
+      }
+
+      const options = {
+        quality: quality
+      }
+
+      if (finalFormat === 'jpeg') {
+        options.mozjpeg = true
+      }
+
+      // 2. 扩展无损压缩判断条件，支持 AVIF
+      if ((finalFormat === 'webp' || finalFormat === 'avif') && lossless) {
+        options.lossless = true
+      }
+
+      // Perform conversion and compression
+      // sharp's toFormat supports setting quality
+      // Note: PNG quality requires libvips support; recent sharp versions typically support it
+      image = image.toFormat(finalFormat, options)
+
+      // Export as Buffer
+      const newBuffer = await image.toBuffer()
+
+      // Update data in ctx.output
+      item.buffer = newBuffer
+      item.base64Image = null // Clear base64 to force buffer upload and avoid confusion
+
+      // If format changed, update file extension
+      if (targetFormat !== 'original') {
+        // 3. 新增 AVIF 格式的扩展名映射
+        const newExt = `.${targetFormat === 'jpeg' ? 'jpg' : targetFormat}`
+        item.fileName = item.fileName.replace(path.extname(item.fileName), newExt)
+        item.extname = newExt
+        ctx.log.info(`[Convertor] Converted ${item.fileName} to ${newExt} with quality ${quality}`)
+      }
+    } catch (e) {
+      ctx.log.error(`[Convertor] Error processing ${item.fileName}: ${e.message}`)
+      // On error, skip processing and upload original, or choose to throw
+    }
+  }))
+
+  return ctx
+}
+
+module.exports = (ctx) => {
+  const register = () => {
+    // Register in the 'beforeUploadPlugins' lifecycle
+    // Intercepts after Transformer (post-file) and before Uploader (pre-upload)
+    ctx.helper.beforeUploadPlugins.register('converter', {
+      handle,
+      config,
+      name: '图片压缩与转换' // Friendly plugin name shown in the GUI
+    })
+  }
+  return {
+    register,
+    config // Export config for PicGo GUI to generate settings menu
+  }
+}