@zzclub/z-cli 0.4.5

package/CHANGELOG.md

@@ -0,0 +1,60 @@
+# Changelog
+
+
+## v0.4.5
+
+[compare changes](https://github.com/aatrooox/z-cli/compare/v0.4.4...v0.4.5)
+
+### 🩹 Fixes
+
+- Env ignore ([535fc54](https://github.com/aatrooox/z-cli/commit/535fc54))
+
+### ❤️ Contributors
+
+- Aatrox <gnakzz@qq.com>
+
+## v0.4.4
+
+[compare changes](https://github.com/aatrooox/z-cli/compare/v0.4.3...v0.4.4)
+
+### 🚀 Enhancements
+
+- 增加版本更新检测机制 ([d8876d3](https://github.com/aatrooox/z-cli/commit/d8876d3))
+
+### ❤️ Contributors
+
+- Aatrox <gnakzz@qq.com>
+
+## v0.4.3
+
+[compare changes](https://github.com/aatrooox/z-cli/compare/v0.4.2...v0.4.3)
+
+## v0.4.2
+
+[compare changes](https://github.com/aatrooox/z-cli/compare/v0.4.1...v0.4.2)
+
+### 🚀 Enhancements
+
+- 配置自动发布npm ([75890f6](https://github.com/aatrooox/z-cli/commit/75890f6))
+
+### 📖 Documentation
+
+- Readme ([f7e5f7c](https://github.com/aatrooox/z-cli/commit/f7e5f7c))
+- LICENSE & readme ([d86fc37](https://github.com/aatrooox/z-cli/commit/d86fc37))
+
+### ❤️ Contributors
+
+- Aatrox <gnakzz@qq.com>
+
+## v0.4.1
+
+[compare changes](https://github.com/aatrooox/zzoffduty-cli/compare/v0.4.0...v0.4.1)
+
+### 🚀 Enhancements
+
+- 修改全局配置文件保存地址；修改项目名称等 ([2d93fae](https://github.com/aatrooox/zzoffduty-cli/commit/2d93fae))
+
+### ❤️ Contributors
+
+- Aatrox <gnakzz@qq.com>
+

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 z-cli
+
+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,195 @@
+# z-cli
+
+**这是一个效率类命令行工具, 为了解决工作中或个人开发过程中的重复或繁琐问题**
+
+ node >= 18.18.0 
+ 
+ 推荐版本(我的)：`20.18.1` 
+
+## 功能一览
+
+- `translate`: 国际化文件翻译 (英译中)
+- `tiny`: 压缩文件。基于sharpjs, sharp支持的文件都可以压缩
+- `picgo`: 通过 Picgo 上传到图床
+   1. 支持指定文件 -f 上传
+   2. 支持指定文件夹 -d 批量上传全部
+   3. 支持限制大小 -m 默认只上传60kb以内的图片
+   4. 支持模糊匹配 -co 文件名中含有co的图片, 且满足大小限制, 都会被上传
+
+**特别注意:**
+**tiny命令不再支持和picgo联动, 仅支持压缩后,自动替换一下md文件里的图片链接, 之后的操作可以用obsidian里的插件[image auto upload Plugin]完成~~**
+
+
+## 安装
+
+`1.0.0` 之前的版本都为不稳定版本
+
+```shell
+npm i -g @zzclub/z-cli
+```
+
+## 翻译功能配置说明
+### 初始化翻译平台appId和key
+
+```shell
+zz set translate account.appId xxx
+zz set translate account.key xxx
+```
+
+### 在哪里可以创建appId和key
+
+> 请使用前仔细阅读百度翻译开发平台相关规则
+
+[百度翻译开放平台](https://fanyi-api.baidu.com/api/trans/product/desktop)
+
+1. 注册
+2. 实名认证
+   1. 标准版 qbs 1  每月5万字符
+   2. 高级版 qbs 10 每月100万字符
+3. 开通通用文本翻译功能
+4. 生成appId和key
+5. 生成后的文件请仔细检查，有可能会有遗漏的翻译，如有，重新执行即可
+6. 注意: 百度翻译的api有一定的调用限制, 请自行评估是否需要使用高级版
+
+### 翻译单个文件
+
+```shell
+zz translate -f ./yourfile.js
+# 会在同级目录下生成 yourfile-en.js
+```
+如test.js
+```js
+export default {
+    isok: '早早下班',
+    common: {
+        listTitle: '标题',
+        addTitle: '测试'
+    },
+    test: {
+        a: {
+            b: {
+                c: '哈哈哈'
+            }
+        },
+        aaa: {
+            value: '输入'
+        }
+    }
+}
+```
+输出文件为test-en.js, 内容如下
+```js
+export default {
+    isok: "Leave work early",
+    common: {
+        listTitle: "title",
+        addTitle: "test"
+    },
+    test: {
+        a: {
+            b: {
+                c: "Hahaha"
+            }
+        },
+        aaa: {
+            value: "input"
+        }
+    }
+}
+```
+### 批量翻译
+
+> 检索目标文件夹内所有langs文件夹下的zh-CN 文件夹下的所有文件, 输出至其同级的en-US下, 文件名同名
+
+```shell
+zz translate -d ./demo
+```
+如: demo文件夹是以下结构, zh-CN中所有JS会翻译后输出至en-US
+
+每个文件输出内容同翻译单个文件
+
+```bash
+.
+├── en-US
+│   ├── test.js
+│   ├── test2.js
+│   └── test3.js
+├── test-en.js
+├── test.js
+└── zh-CN
+    ├── test.js
+    ├── test2.js
+    └── test3.js
+
+
+```
+## 压缩图片
+
+使用help命令查看所有支持的功能
+```
+zz tiny --help
+
+  -t, --type <fileType>         转换后的图片类型 (default: null)
+  -f, --file <file>             要压缩的图片文件 (default: null)
+  -d, --dir <dir>               压缩文件夹内所有文件 (default: null)
+  -co, --condition <condition>  压缩文件夹内所有名称包含[--condition]的图片文件 (default: null)
+  -q, --quality <quality>       压缩质量(1-100) (default: 75)
+  -c, --colours <colours>       GIF色彩保留(2-256) (default: 128)
+  -n, --name <name>             指定文件名输出 (default: "")
+  -m, --max <max>               限制要上传的文件大小(kb)(仅当开启 --picgo 时会用到) (default: 60)
+  --picgo [type]                调用picgo (无参数) (default: null)
+  --no-picgo [type]             不调用picgo (无参数) (default: null)
+  -h, --help                    display help for command
+```
+
+## 通过PicGo上传到图床
+
+**此功能通过Http请求的方式调用Picgo Server, 所以需要本地已经安装并启动Picgo, 并已经配置好了图床**
+
+使用help命令查看所有支持的功能
+
+```
+Options:
+  -f, --file <file>             要上传的图片文件 (default: null)
+  -d, --dir <dir>               上传文件夹内所有图片文件 (default: null)
+  -co, --condition <condition>  上传文件夹内所有名称包含[--condition]的图片文件 (default: null)
+  -m, --max <max>               大于指定大小(kb)的图片不会被上传 (default: 60)
+  -h, --help                    display help for command
+```
+
+## Obsidian相关（Alpha）
+1. 如果你使用Obsidian编写markdown,本工具还提供了一个压缩=>上传=>自动替换文件路径为外链的联动功能, 请仔细阅读以下!!!
+2. 我的设置是: **设置=>文件与连接=>附件默认存放路径=> 当前文件所在文件夹下指定的子文件夹中 =>子文件夹名称: 配图**
+   1. 这样做的原因是, 方便你用tiny命令压缩**所有和这篇文章相关的图片**, 当然你自己指定压缩的目录下文件不多的话, 也可以
+   2. Obsidian里, 插入本地图片的语法为 `![[demo.png]]` , 此联动功能目前**只支持替换图片名称**, 替换后的字符串为 `![[demo-tiny.png]]`
+3. 注意参数要打全, 缺一不可
+      1.  使用--replace 参数, 开启替换功能
+      2.  使用--replace-file=./xxx.md 参数, 指定需要替换的markdown文件
+      3.  正确演示: **zz tiny -d ./demo/md/配图 --replace --replace-file=./demo/md/demo5.md**
+4. Obsidian文件替换后, 应该是不能用撤回键回退了, **所以先拿一个没用的文件, 玩明白了再开始搞自己的重要文件, 如有问题, 自己承担!**
+5. 第四条不会造成图片文件丢失,只是贴图太多的话,一般图片名称没有规则, 再还原就比较恶心了
+6. 压缩完成,替换完成后, 请使用image auto upload 插件来进行上传操作. 后续看能否给作者提PR加入压缩功能
+7. **演示文件在demo/md里**
+
+
+## 提出新需求、定制
+
+欢迎提出新需求，只要合理、常见，我会尽快集成。
+
+或有定制需求
+
+请联系V详谈: 523748995
+
+## 免责声明
+
+任何用户在使用 z-cli 前，请您仔细阅读并透彻理解本声明。您可以选择不使用 z-cli ，若您一旦使用 z-cli ，您的使用行为即被视为对本声明全部内容的认可和接受。
+
+1. 任何单位或个人因下载使用 z-cli 而产生的任何意外、疏忽、合约毁坏、诽谤、版权或知识产权侵犯及其造成的损失 (包括但不限于直接、间接、附带或衍生的损失等)，本人不承担任何法律责任。
+
+2. 任何单位或个人不得在未经本团队书面授权的情况下对 z-cli 工具本身申请相关的知识产权。
+
+3. 如果本声明的任何部分被认为无效或不可执行，则该部分将被解释为反映本人的初衷，其余部分仍具有完全效力。不可执行的部分声明，并不构成我放弃执行该声明的权利。
+
+## LICENSE
+
+[MIT](/LICENSE)

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@zzclub/z-cli",
+  "version": "0.4.5",
+  "description": "all-in-one 工具箱，专为提升日常及工作效率而生",
+  "main": "src/index.js",
+  "type": "module",
+  "author": "aatrox",
+  "bin": {
+    "z": "src/index.js",
+    "zz": "src/index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aatrooox/z-cli.git"
+  },
+  "keywords": [
+    "cli",
+    "zz",
+    "zzclub",
+    "node",
+    "sharp",
+    "translate",
+    "picgo",
+    "tool"
+  ],
+  "scripts": {
+    "release": "pnpm release:patch",
+    "release:patch": "npx changelogen@latest --patch --release --push --publish",
+    "release:minor": "npx changelogen@latest --minor --release --push --publish",
+    "release:major": "npx changelogen@latest --major --release --push --publish",
+    "release:main": "npx changelogen@latest -r v1.0.0 --release --push --publish"
+  },
+  "engines": {
+    "node": ">=18.18.0"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "axios": "1.6.2",
+    "chalk": "5.3.0",
+    "commander": "11.0.0",
+    "inquirer": "9.2.8",
+    "latest-version": "^9.0.0",
+    "ora": "7.0.0",
+    "sharp": "0.33.0",
+    "shelljs": "0.8.5"
+  }
+}

package/src/command/config.js

@@ -0,0 +1,97 @@
+import { writeFileContent, getLocalConfig, readJsonFile, setLocalConfig } from "../utils/common.js";
+import chalk from "chalk";
+import ora from "ora";
+import path from "node:path";
+import fs, { lchown } from "node:fs";
+import { dirname } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+function checkFilepath(filePath, configName, spinner) {
+  if (!filePath) {
+    let caseText;
+    if (configName === "export") {
+      caseText = `导出到指定目录 => zz config export /home/data`;
+    }
+    if (configName === "import") {
+      caseText = `导入指定配置文件 => zz config import /home/data/我的配置.json`;
+    }
+    spinner.fail("请指定文件路径后重试, 如:" + caseText);
+    return false;
+  }
+
+  return true;
+}
+export const configCmd = {
+  name: "config <configName> [payload...]",
+  description:
+    "全局config.json的导入[import]/导出[export]/还原[reset] \n如: zz config import ./abc.json",
+  options: [],
+  action: async (configName, payload, cmd) => {
+    let config_spinner = ora();
+    let config = await getLocalConfig();
+    let filePath = payload[0];
+    switch (configName) {
+      // 导出config
+      case "export":
+        //导出
+        if (checkFilepath(filePath, configName, config_spinner)) {
+          try {
+            let stats = fs.statSync(filePath);
+            let isDir = stats.isDirectory();
+            if (isDir) {
+              // 有效的文件夹路径, 无文件名, 生成默认的json名
+              filePath = path.resolve(
+                __dirname,
+                filePath,
+                "zzclub-z-cli.json"
+              );
+              fs.writeFileSync(
+                filePath,
+                JSON.stringify(config, null, 2),
+                "utf-8"
+              );
+              config_spinner.succeed(`导出配置成功! [${filePath}]`);
+            }
+          } catch (error) {
+            config_spinner.fail(`不存在的文件夹路径: [${filePath}]`);
+          }
+        }
+        process.exit(1);
+      case "import":
+        //导入
+        if (checkFilepath(filePath, configName, config_spinner)) {
+          try {
+            let stats = fs.statSync(filePath);
+            let isFile = stats.isFile();
+            if (isFile) {
+              let extname = path.extname(filePath);
+              if (extname !== ".json") {
+                config_spinner.fail(`只支持导入json文件: [${filePath}]`);
+                process.exit(1);
+              }
+              let localConfig = await readJsonFile(filePath);
+              let result = Object.assign({}, config, localConfig);
+              
+              setLocalConfig(result, config_spinner)
+              config_spinner.succeed(`导入配置成功!`);
+            } else {
+              config_spinner.fail(`不存在的文件路径: [${filePath}]`);
+            }
+          } catch (error) {
+            config_spinner.fail(`不存在的文件路径: [${filePath}]`);
+          }
+        }
+        process.exit(1);
+      case "reset":
+        //重置
+        setLocalConfig({}, config_spinner)
+        config_spinner.succeed(`已重置为默认配置!`);
+        process.exit(1);
+    }
+
+    config_spinner.fail(`不存在操作: [${configName}]`);
+    process.exit(1);
+  },
+};

package/src/command/index.js

@@ -0,0 +1,26 @@
+import { dirname } from "node:path";
+import { fileURLToPath } from "node:url";
+import path from "node:path";
+import ora from "ora";
+import { readJsonFile } from "../utils/common.js";
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+export const registerCommand = (program, config) => {
+  let app = program.command(config.name).description(config.description);
+
+  config.options.forEach((option) => {
+    app.option(option.flags, option.description, option.defaultValue);
+  });
+
+  app.action(config.action);
+};
+
+export const initProgram = async (program, cb) => {
+  readJsonFile(path.resolve(__dirname, "../../package.json")).then((pkg) => {
+    program.usage("<command> [options]");
+    program.version(pkg.version);
+
+    cb && cb();
+  });
+};

package/src/command/picgo.js

@@ -0,0 +1,122 @@
+import {
+  writeFileContent,
+  getLocalConfig,
+  setHighLightStr,
+} from "../utils/common.js";
+import {
+  requestPicGo,
+  checkFileSize,
+  checkFileSizeAndFilter,
+  uploadFileByPicGo,
+  batchUploadByPicGo,
+} from "../utils/picgo.js";
+import { getFormatedFileSize, replaceFileContent } from "../utils/file.js";
+import chalk from "chalk";
+import ora from "ora";
+import path from "node:path";
+import { dirname } from "node:path";
+import { fileURLToPath } from "node:url";
+import fs from "node:fs";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const supportFileTypes = ["png", "jpg", "jpeg", "gif", "webp"];
+
+export const picgoCmd = {
+  name: "picgo",
+  description: "上传图片(此命令暂时废弃, 原因见readme)",
+  options: [
+    {
+      flags: "-f, --file <file>",
+      description: "要上传的图片文件",
+      defaultValue: null,
+    },
+    {
+      flags: "-d, --dir <dir>",
+      description: "上传文件夹内所有文件",
+      defaultValue: null,
+    },
+    {
+      flags: "-co, --condition <condition>",
+      description: "上传文件夹内所有名称包含[--condition]的图片文件",
+      defaultValue: null,
+    },
+    {
+      flags: "-m, --max <max>",
+      description: "大于指定大小的图片不会被上传",
+      defaultValue: 60,
+    },
+  ],
+  action: async (option, test) => {
+    const spinner = ora();
+    const config = await getLocalConfig();
+    const { file, dir, condition, tinyFiles } = option;
+
+    if (!file && !dir && !condition && (!tinyFiles || !tinyFiles.length)) {
+      spinner.fail("请指定要上传的文件(--file=xxx)或文件夹(--dir=/a/b)");
+      process.exit(1);
+    }
+
+    // const _replaceMaps = replaceMaps.concat();
+    // 从压缩命令调用过来的
+    if (tinyFiles && tinyFiles.length) {
+      await batchUploadByPicGo(tinyFiles, option);
+      if (!option.replace) process.exit(1);
+      spinner.start("开始替换文件内容, 替换后请仔细检查!");
+      const fileContent = await replaceFileContent(
+        option.replaceFile,
+        option.replaceMaps
+      );
+      if (!fileContent) {
+        spinner.fail("替换文件内容失败! 请检查要替换的文件是否存在!");
+        process.exit(1);
+      }
+      fs.writeFile(option.replaceFile, fileContent, "utf-8", (error) => {
+        if (!error) {
+          spinner.succeed(
+            `[${chalk.red(
+              path.basename(option.replaceFile)
+            )}]图片链接替换完成!请前往检查!`
+          );
+        } else {
+          console.log(error);
+          //   spinner.fail(`写入${chalk.red(filePath)}文件失败, 请重试`);
+          spinner.fail("图片链接替换失败!");
+        }
+        process.exit(1);
+      });
+    }
+    // 指定文件上传
+    if (file) {
+      await uploadFileByPicGo(file, option);
+      process.exit(1);
+    }
+
+    // 指定文件夹, 翻译文件夹内所有文件
+    if (dir || condition) {
+      let inputDirPath = dir || "./";
+      let files;
+      try {
+        // 读取所有文件
+        files = fs.readdirSync(inputDirPath);
+        files = files.map((filePath) =>
+          path.resolve(process.cwd(), inputDirPath, filePath)
+        );
+
+        files = files.filter((f) => {
+          let fileName = path.basename(f);
+          let index = fileName.indexOf(condition);
+          return index !== -1;
+        });
+        await batchUploadByPicGo(files, option);
+        // spinner.succeed(`共有${files.length}个文件${files}`);
+      } catch (err) {
+        spinner.fail("出错啦, 文件夹似乎不存在");
+        process.exit(1);
+      }
+
+      process.exit(1);
+    }
+  },
+};

package/src/command/replace.js

@@ -0,0 +1,81 @@
+import {
+  writeFileContent,
+  getLocalConfig,
+  setHighLightStr,
+} from "../utils/common.js";
+import {
+  requestPicGo,
+  checkFileSize,
+  checkFileSizeAndFilter,
+  uploadFileByPicGo,
+  batchUploadByPicGo,
+} from "../utils/picgo.js";
+import { getFormatedFileSize } from "../utils/file.js";
+import chalk from "chalk";
+import ora from "ora";
+import path from "node:path";
+import { dirname } from "node:path";
+import { fileURLToPath } from "node:url";
+import fs from "node:fs";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const supportFileTypes = ["png", "jpg", "jpeg", "gif", "webp"];
+
+export const replaceCmd = {
+  name: "replace",
+  description:
+    "替换文字功能, 用于上传后文件后, 自动更换markdown里的图片链接(还在开发中)",
+  options: [
+    {
+      flags: "-f, --file <file>",
+      description: "目标文件",
+      defaultValue: "",
+    },
+    {
+      flags: "-t, --text <text>",
+      description: "要替换的文字",
+      defaultValue: "",
+    },
+    {
+      flags: "-nt, --new-text <nextText>",
+      description: "替换后的文字内容",
+      defaultValue: null,
+    },
+    {
+      flags: "-co, --condition <condition>",
+      description: "上传文件夹内所有名称包含[--condition]的图片文件",
+      defaultValue: null,
+    },
+    {
+      flags: "-m, --max <max>",
+      description: "大于指定大小的图片不会被上传",
+      defaultValue: 60,
+    },
+  ],
+  action: async (option) => {
+    const spinner = ora();
+    const config = await getLocalConfig();
+    const { text, newText, file } = option;
+
+    if (!text && !newText && !file) {
+      spinner.fail("请指定要替换的文件及替换方式");
+      process.exit(1);
+    }
+
+    // 绝对路径
+    let filePath = path.resolve(process.cwd(), file);
+
+    try {
+      // 使用fs.readFileSync读取文件内容
+      // let fileContent = fs.readFileSync(filePath);
+      // 将文件内容转换为JSON对象
+      // fileContent = fileContent.replaceAll(text, newText)
+      // replaceFileContent(filePath, [{text, newText}])
+    } catch (err) {
+      // 如果读取文件失败，则将jsonData初始化为空对象
+      jsonData = {};
+    }
+  },
+};