picgo-plugin-gitee 2.0.7 → 2.0.8

package/package.json

@@ -1,17 +1,37 @@
 {
   "name": "picgo-plugin-gitee",
-  "version": "2.0.7",
+  "version": "2.0.8",
   "description": "picgo uploader for gitee",
   "main": "src/index.js",
+  "files": [
+    "src/**/*",
+    "readme.md",
+    "LICENSE"
+  ],
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
   },
   "homepage": "https://github.com/zhanghuid/picgo-plugin-gitee",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zhanghuid/picgo-plugin-gitee.git"
+  },
+  "bugs": {
+    "url": "https://github.com/zhanghuid/picgo-plugin-gitee/issues"
+  },
   "scripts": {
+    "lint": "eslint src/index.js",
     "test": "echo \"Error: no test specified\" && exit 1",
-    "patch": "npm version patch && git push origin master && git push origin --tags",
-    "minor": "npm version minor && git push origin master && git push origin --tags",
-    "major": "npm version major && git push origin master && git push origin --tags"
+    "bump": "bumpp --commit \"chore(release): v%s\"",
+    "bump:patch": "bumpp patch --commit \"chore(release): v%s\"",
+    "bump:minor": "bumpp minor --commit \"chore(release): v%s\"",
+    "bump:major": "bumpp major --commit \"chore(release): v%s\"",
+    "release": "npm run bump && npm publish",
+    "release:patch": "npm run bump:patch && npm publish",
+    "release:minor": "npm run bump:minor && npm publish",
+    "release:major": "npm run bump:major && npm publish",
+    "prepublishOnly": "node --check src/index.js"
   },
   "keywords": [
     "picgo",
@@ -21,13 +41,13 @@
   "author": "zhanghuid",
   "license": "MIT",
   "devDependencies": {
+    "@varnxy/logger": "^1.1.2",
+    "bumpp": "^12.3.0",
     "eslint": "^5.0.1",
     "eslint-config-standard": "^11.0.0",
     "eslint-plugin-import": "^2.13.0",
     "eslint-plugin-node": "^6.0.1",
     "eslint-plugin-promise": "^3.8.0",
-    "eslint-plugin-standard": "^3.1.0",
-    "@varnxy/logger": "^1.1.2"
-  },
-  "dependencies": {}
-}
+    "eslint-plugin-standard": "^3.1.0"
+  }
+}

package/readme.md

@@ -17,9 +17,12 @@ npm i picgo-plugin-gitee
 #### input your config
 - owner: gitee project's owner name
 - repo: gitee project repo
-- token: gitee's api token
-- path: img path in response json (eg:url or data.url)
-- message: gitee commit 
+- path: img path in response json (eg:url or data.url), 根目录可留空
+- token: gitee's api token（在 https://gitee.com/profile/personal_access_tokens 生成）
+- customUrl: 自定义独立域名（可选），留空默认使用 `https://raw.giteeusercontent.com`，避免默认域名被 302 重定向
+- message: gitee commit，默认 `picgo commit`
+
+> 默认预览地址使用 [Gitee 独立域名 `raw.giteeusercontent.com`](https://help.gitee.com/repository/file-operate/raw#%E7%8B%AC%E7%AB%8B%E5%9F%9F%E5%90%8D)，不再走 `gitee.com` 的 302。 
 
 #### init your remote repo
 - create git repo?
@@ -42,6 +45,7 @@ git push -u origin master
 
 ### Feature
 - support sync gitee file delete
+- 上传/删除结束均会弹出系统通知（PicGo 消息中心）
 
 ### Todo
 

package/src/index.js

@@ -1,5 +1,9 @@
 const uploadedName = "gitee";
 const domain = "https://gitee.com";
+// 独立域名：直接命中，避免走默认域名的 302 重定向。
+// 参考：https://help.gitee.com/repository/file-operate/raw#%E7%8B%AC%E7%AB%8B%E5%9F%9F%E5%90%8D
+const previewDomain = "https://raw.giteeusercontent.com";
+const apiPath = "/api/v5/repos";
 const urlParser = require("url");
 const defaultMsg = "picgo commit";
 
@@ -28,9 +32,9 @@ module.exports = (ctx) => {
     }
 
     userConfig["baseUrl"] =
-      domain + "/api/v5/repos/" + userConfig.owner + "/" + userConfig.repo;
+      domain + apiPath + "/" + userConfig.owner + "/" + userConfig.repo;
     userConfig["previewUrl"] =
-      domain +
+      (userConfig.customUrl || previewDomain) +
       "/" +
       userConfig.owner +
       "/" +
@@ -51,6 +55,10 @@ module.exports = (ctx) => {
       userConfig.baseUrl + "/contents" + formatConfigPath(userConfig);
 
     let imgList = ctx.output;
+    let successCount = 0;
+    let failCount = 0;
+    const fails = [];
+
     for (let i in imgList) {
       let image = imgList[i].buffer;
       if (!image && imgList[i].base64Image) {
@@ -64,32 +72,53 @@ module.exports = (ctx) => {
         await ctx.Request.request(postConfig);
         imgList[i]["imgUrl"] =
           userConfig.previewUrl + "/" + imgList[i].fileName;
+        successCount += 1;
+        ctx.log.info(
+          "[上传操作]成功：" + imgList[i].fileName + " -> " + imgList[i].imgUrl
+        );
       } catch (err) {
-        ctx.log.info("[上传操作]异常：" + err.message);
         // duplicate file, so continue
         if (checkIsDuplicateFile(err.message)) {
+          ctx.log.info("[上传操作]文件已存在：" + imgList[i].fileName);
           ctx.emit("notification", {
             title: "上传失败",
-            body: "文件已经存在了",
+            body: `${imgList[i].fileName} 文件已经存在了`,
           });
+          failCount += 1;
           continue;
-        } else {
-          ctx.emit("notification", {
-            title: "上传失败",
-            body: JSON.stringify(err),
-          });
         }
+        failCount += 1;
+        fails.push(`${imgList[i].fileName}: ${err.message}`);
+        ctx.log.info("[上传操作]异常：" + err.message);
+        ctx.emit("notification", {
+          title: "上传失败",
+          body: `${imgList[i].fileName} ${err.message}`,
+        });
       }
 
       delete imgList[i].base64Image;
       delete imgList[i].buffer;
     }
 
+    // 上传结束后统一给一条汇总通知，避免每次上传都点弹窗打扰用户。
+    if (successCount > 0) {
+      ctx.emit("notification", {
+        title: "上传完成",
+        body: `成功 ${successCount} 张${failCount > 0 ? `，失败 ${failCount} 张` : ""}`,
+      });
+    }
+    if (fails.length > 0) {
+      ctx.log.info("[上传操作]失败明细：" + JSON.stringify(fails));
+    }
+
     return ctx;
   };
 
   const checkIsDuplicateFile = (message) => {
-    return message.indexOf("A file with this name already exists") != -1;
+    return (
+      message.indexOf("A file with this name already exists") != -1 ||
+      message.indexOf("文件已经存在") != -1
+    );
   };
 
   const postOptions = (url, image) => {
@@ -111,53 +140,97 @@ module.exports = (ctx) => {
 
   // trigger delete file
   const onRemove = async function (files) {
-    // log request params
     const rms = files.filter((each) => each.type === uploadedName);
     if (rms.length === 0) {
       return;
     }
 
     ctx.log.info("删除个数:" + rms.length);
-    ctx.log.info("uploaded 信息:");
     let headers = getHeaders();
     let config = getUserConfig();
-    const fail = [];
+    const fails = [];
+    const successNames = [];
 
     for (let i = 0; i < rms.length; i++) {
       const each = rms[i];
       let filepath = getFilePath(each.imgUrl);
-      let sha = await getSha(filepath).catch((err) => {
-        ctx.log.info("[删除操作]获取sha值：" + JSON.stringify(err));
-      });
+      let sha;
+      try {
+        sha = await getSha(filepath);
+      } catch (err) {
+        ctx.log.info(
+          "[删除操作]获取 sha 失败，跳过：" + each.imgUrl + " " + err.message
+        );
+        fails.push(`${each.fileName || each.imgUrl}: 获取 sha 失败`);
+        ctx.emit("notification", {
+          title: "删除失败",
+          body: `${each.fileName || each.imgUrl} 获取 sha 失败`,
+        });
+        continue;
+      }
 
-      let url =
+      if (!sha) {
+        ctx.log.info("[删除操作]sha 为空，文件可能已被删除：" + each.imgUrl);
+        fails.push(`${each.fileName || each.imgUrl}: 文件不存在`);
+        continue;
+      }
+
+      const url =
         `${filepath}` +
         `?access_token=${config.token}` +
-        `&message=${config.message}` +
+        `&message=${encodeURIComponent(config.message || defaultMsg)}` +
         `&sha=${sha}`;
       ctx.log.info("[删除操作]当前删除地址：" + url);
-      let opts = {
+      const opts = {
         method: "DELETE",
-        url: encodeURI(url),
+        url: url,
         headers: headers,
       };
-      ctx.log.info("[删除操作]当前参数" + JSON.stringify(opts));
-      // log request params
-      response = await ctx.request(opts);
-      ctx.log.info(response);
+      try {
+        const response = await ctx.Request.request(opts);
+        ctx.log.info("[删除操作]响应：" + response);
+        successNames.push(each.fileName || each.imgUrl);
+      } catch (err) {
+        ctx.log.info(
+          "[删除操作]失败：" +
+            (each.fileName || each.imgUrl) +
+            " " +
+            err.message
+        );
+        fails.push(`${each.fileName || each.imgUrl}: ${err.message}`);
+        ctx.emit("notification", {
+          title: "删除失败",
+          body: `${each.fileName || each.imgUrl} ${err.message}`,
+        });
+      }
     }
 
-    ctx.emit("notification", {
-      title: "删除提示",
-      body: fail.length === 0 ? "成功同步删除" : `删除失败${fail.length}个`,
-    });
+    // 汇总通知，避免重复打扰。
+    if (successNames.length > 0) {
+      ctx.emit("notification", {
+        title: "删除完成",
+        body:
+          `成功同步删除 ${successNames.length} 个` +
+          (fails.length > 0 ? `，失败 ${fails.length} 个` : ""),
+      });
+    }
+    if (fails.length > 0) {
+      ctx.log.info("[删除操作]失败明细：" + JSON.stringify(fails));
+    }
   };
 
+  // 把预览 URL 转成删除用的 API URL。
+  // previewUrl 可能是默认域名、独立域名（raw.giteeusercontent.com）或用户自定义 customUrl，
+  // 但 Gitee API 始终在 gitee.com，所以这里统一映射到 gitee.com/api/v5/repos/...。
   const getFilePath = function (url) {
-    let pathInfo = urlParser.parse(url);
-    let baseUrl = pathInfo.protocol + "//" + pathInfo.host;
-    let urlStr = url.replace(baseUrl, baseUrl + "/api/v5/repos");
-    return urlStr.replace("raw/master", "contents");
+    let parsed = urlParser.parse(url);
+    // 去掉 raw/master，保留 owner/repo/path
+    let urlStr = url.replace("raw/master", "contents");
+    // 把 host 替换为 gitee.com，并插入 /api/v5/repos
+    return urlStr.replace(
+      `${parsed.protocol}//${parsed.host}`,
+      `${parsed.protocol}//gitee.com${apiPath}`
+    );
   };
 
   const getSha = async function (filepath) {
@@ -167,7 +240,7 @@ module.exports = (ctx) => {
 
     const opts = {
       method: "GET",
-      url: encodeURI(url),
+      url: url,
       headers: headers,
     };
 
@@ -187,21 +260,15 @@ module.exports = (ctx) => {
       userConfig = {};
     }
     return [
-      // {
-      //   name: 'url',
-      //   type: 'input',
-      //   default: userConfig.url,
-      //   required: true,
-      //   message: 'https://gitee.com',
-      //   alias: 'url'
-      // },
       {
         name: "owner",
         type: "input",
         default: userConfig.owner,
         required: true,
         message: "owner",
-        alias: "owner",
+        alias: "仓库所属用户/组织",
+        tips:
+          "仓库 owner，例如仓库地址 https://gitee.com/zhanghuid/resources 中 owner 为 zhanghuid",
       },
       {
         name: "repo",
@@ -209,23 +276,37 @@ module.exports = (ctx) => {
         default: userConfig.repo,
         required: true,
         message: "repo",
-        alias: "repo",
+        alias: "仓库名",
+        tips: "仓库名，例如 resources",
       },
       {
         name: "path",
         type: "input",
         default: userConfig.path,
         required: false,
-        message: "path;根目录可不用填",
-        alias: "path",
+        message: "根目录可留空，例如 img/2026",
+        alias: "存储路径",
+        tips: "图片在仓库内的存储子目录，根目录可不填",
       },
       {
         name: "token",
-        type: "input",
+        type: "password",
         default: userConfig.token,
         required: true,
-        message: "5664b5620fb11111e3183a98011113ca31",
-        alias: "token",
+        message: "Gitee 私人令牌",
+        alias: "私人令牌 (token)",
+        tips:
+          "在 https://gitee.com/profile/personal_access_tokens 生成，需要 projects 和 pull_request 权限",
+      },
+      {
+        name: "customUrl",
+        type: "input",
+        default: userConfig.customUrl,
+        required: false,
+        message: "可留空，默认使用 raw.giteeusercontent.com",
+        alias: "自定义独立域名（可选）",
+        tips:
+          "如有自有独立域名（反代 raw.giteeusercontent.com 或 Gitee Page 绑定的域名），填这里；留空则默认使用 https://raw.giteeusercontent.com",
       },
       {
         name: "message",
@@ -233,7 +314,8 @@ module.exports = (ctx) => {
         default: userConfig.message,
         required: false,
         message: defaultMsg,
-        alias: "message",
+        alias: "提交信息 (commit message)",
+        tips: "上传/删除文件时使用的 commit message，留空使用默认 picgo commit",
       },
     ];
   };

package/.eslintrc

@@ -1,3 +0,0 @@
-{
-  "extends": "standard"
-}

package/CONTRIBUTING.md

@@ -1,14 +0,0 @@
-# 开发者说明
-
-## 开发环境搭建
-[插件测试与发布](https://picgo.github.io/PicGo-Core-Doc/zh/dev-guide/deploy.html#%E6%99%AE%E9%80%9A%E6%8F%92%E4%BB%B6)
-[图片转base64工具](https://tool.chinaz.com/tools/imgtobase)
-
-## 相关 API
-- [新建文件](https://gitee.com/api/v5/swagger#/postV5ReposOwnerRepoContentsPath)
-- [删除文件](https://gitee.com/api/v5/swagger#/deleteV5ReposOwnerRepoContentsPath)
-
-## 步骤
-1. 按照 **开发环境搭建 > 插件测试与发布** 的教程，直接使用本地安装
-2. 安装完后，重启应用生效
-3. 更改 `package.json`的版本号