feat: 优化 CLI 工具的输出文件处理逻辑

h7ml · h7ml · commit 4bc6f4b4e254 · 2024-12-14T13:14:53.000+08:00
- 添加默认输出文件名功能，如果没有指定输出文件名，则使用输入文件名
- 校验输出文件名的有效性
- 优化代码块的处理，移除多余的代码块标记
- 更新 README 文档，明确输出文件的默认行为
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -17,6 +17,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          ref: main
 
       - name: Set up Node.js
         uses: actions/setup-node@v3
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -13,6 +13,7 @@ jobs:
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
+          ref: main
 
       - name: Setup pnpm
         uses: pnpm/action-setup@v2
@@ -76,14 +77,15 @@ jobs:
           git config advice.ignoredHook false
           VERSION=${GITHUB_REF#refs/tags/v}
           git commit -m "chore(release): update CHANGELOG for v$VERSION [skip ci]" -a || echo "No changes to commit"
-          BRANCH=$(echo "${GITHUB_REF}" | sed 's@refs/tags/@@')
-          git push origin HEAD:$BRANCH || echo "Push to repository failed"
 
+          git checkout main || git checkout -b main 
+
+          git push origin main || echo "Push to repository failed"
 
       - name: Upload Release Assets
         uses: softprops/action-gh-release@v1
         with:
           body_path: CHANGELOG.md
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        continue-on-error: true
+        continue-on-error: true
diff --git a/README-zh.md b/README-zh.md
@@ -1,42 +1,42 @@
-以下是“ai-markdown-translator”文档的修订和合并版本，其中结合了`npx`和`./ai-markdown-translator`示例：
+以下是经过修订和整合的 `ai-markdown-translator` 文档，其中结合了 `npx` 和 `./ai-markdown-translator` 的示例：
 
 ---
 
 # ai-markdown-translator
 
 <div>
-  <a href="https://www.npmjs.org/package/ai-markdown-translator"><img src="https://img.shields.io/npm/v/ai-markdown-translator.svg?style=flat" alt="NPM 版本"></a>
+  <a href="https://www.npmjs.org/package/ai-markdown-translator"><img src="https://img.shields.io/npm/v/ai-markdown-translator.svg?style=flat" alt="NPM版本"></a>
   <a href="https://github.com/h7ml/ai-markdown-translator/actions/workflows/ci.yml"><img src="https://github.com/h7ml/ai-markdown-translator/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
-  <a href="https://github.com/h7ml/ai-markdown-translator/actions/workflows/release.yml"><img src="https://github.com/h7ml/ai-markdown-translator/actions/workflows/release.yml/badge.svg" alt="发布"></a>
-  <a href="https://www.npmjs.org/package/ai-markdown-translator"><img src="https://img.shields.io/npm/dw/ai-markdown-translator" alt="NPM 下载量"></a>
-  <a href="https://www.npmjs.org/package/ai-markdown-translator"><img src="https://img.shields.io/npm/l/ai-markdown-translator" alt="NPM 许可证"></a>
-  <a href="https://github.com/h7ml/ai-markdown-translator/stargazers"><img src="https://img.shields.io/github/stars/h7ml/ai-markdown-translator.svg" alt="GitHub 星标"></a>
-  <a href="https://github.com/h7ml/ai-markdown-translator/issues"><img src="https://img.shields.io/github/issues/h7ml/ai-markdown-translator.svg" alt="GitHub 问题"></a>
-  <a href="https://github.com/h7ml/ai-markdown-translator/network/members"><img src="https://img.shields.io/github/forks/h7ml/ai-markdown-translator.svg" alt="GitHub 分叉"></a>
-  <a href="https://github.com/h7ml/ai-markdown-translator/graphs/contributors"><img src="https://img.shields.io/github/contributors/h7ml/ai-markdown-translator.svg" alt="GitHub 贡献者"></a>
+  <a href="https://github.com/h7ml/ai-markdown-translator/actions/workflows/release.yml"><img src="https://github.com/h7ml/ai-markdown-translator/actions/workflows/release.yml/badge.svg" alt="Release"></a>
+  <a href="https://www.npmjs.org/package/ai-markdown-translator"><img src="https://img.shields.io/npm/dw/ai-markdown-translator" alt="NPM下载"></a>
+  <a href="https://www.npmjs.org/package/ai-markdown-translator"><img src="https://img.shields.io/npm/l/ai-markdown-translator" alt="NPM许可证"></a>
+  <a href="https://github.com/h7ml/ai-markdown-translator/stargazers"><img src="https://img.shields.io/github/stars/h7ml/ai-markdown-translator.svg" alt="GitHub Stars"></a>
+  <a href="https://github.com/h7ml/ai-markdown-translator/issues"><img src="https://img.shields.io/github/issues/h7ml/ai-markdown-translator.svg" alt="GitHub问题"></a>
+  <a href="https://github.com/h7ml/ai-markdown-translator/network/members"><img src="https://img.shields.io/github/forks/h7ml/ai-markdown-translator.svg" alt="GitHub分支"></a>
+  <a href="https://github.com/h7ml/ai-markdown-translator/graphs/contributors"><img src="https://img.shields.io/github/contributors/h7ml/ai-markdown-translator.svg" alt="GitHub贡献者"></a>
 </div>
 
 [English](README.md) | [中文](README-zh.md)
 
-`ai-markdown-translator` 是一个命令行工具，使用 OpenAI 的语言模型将 Markdown 文件从一种语言翻译成另一种语言。它在翻译内容的同时保持 Markdown 语法不变。
+`ai-markdown-translator` 是一个命令行工具，能利用OpenAI的语言模型将Markdown文件从一种语言翻译成另一种语言。它在翻译内容的同时保持了Markdown语法的完整性。
 
-## 功能
+## 特性
 
-- 将 Markdown 文件翻译为 OpenAI 模型支持的任何语言。
-- 在翻译过程中保持 Markdown 语法不变。
+- 使用OpenAI的模型将Markdown文件翻译成任何受支持的语言。
+- 在翻译过程中保持Markdown语法。
 - 通过命令行参数或环境变量灵活配置。
 
 ## 先决条件
 
-- Node.js（版本14或更高）
-- npm（通常随 Node.js 一起提供）
-- 一个 OpenAI API 密钥
+- Node.js（v14或更高版本）
+- npm（通常与Node.js一起提供）
+- OpenAI API密钥
 
 ## 安装
 
-1. 克隆此存储库或下载源代码。
-2. 在终端中进入项目目录。
-3. 安装依赖项：
+1. 克隆此仓库或下载源代码。
+2. 在终端中导航到项目目录。
+3. 安装依赖：
 
 ```bash
 npm install
@@ -50,31 +50,31 @@ npm run build
 
 ## 脚本
 
-- `build`: 将 TypeScript 文件编译为 JavaScript。
-- `start`: 使用 Node.js 运行编译后的 JavaScript。
-- `lint`: 运行 ESLint 检查 TypeScript 文件中的代码质量问题。
-- `lint:fix`: 自动修复 TypeScript 文件中的 lint 问题。
-- `format`: 使用 Prettier 格式化 `src` 目录中各种文件类型的代码。
-- `format:check`: 检查代码格式而不进行更改。
-- `postbuild`: 使编译后的 `index.js` 文件可执行。
-- `changelog`: 基于惯例提交生成变更日志。
-- `version`: 更新变更日志并在版本控制时准备提交。
-- `test`: 构建项目并运行测试。
+- `build`：将TypeScript文件编译成JavaScript。
+- `start`：使用Node.js运行编译的JavaScript。
+- `lint`：运行ESLint以检查 TypeScript 文件中的代码质量问题。
+- `lint:fix`：自动修复 TypeScript 文件中的linting问题。
+- `format`：使用Prettier格式化`src`目录中多种文件类型的代码。
+- `format:check`：检查代码格式，但不进行修改`src`目录中多种文件类型的代码。
+- `postbuild`：使编译的`index.js`文件可执行。
+- `changelog`：基于常规提交生成更新日志。
+- `version`：在版本控制时更新更新日志并将其暂存为提交。
+- `test`：构建项目并运行测试。
 
-## 用法
+## 使用方法
 
-可以使用 Node.js、`npx` 或作为独立可执行文件（如果已打包）运行 CLI 工具。
+你可以使用Node.js、`npx`或者作为独立的可执行文件运行CLI工具（如果你打包过它）。
 
-### 使用 Node.js
+### 使用Node.js
 
 ```bash
-node dist/index.js --input <input-file> --output <output-file> --language <target-language> [options]
+node dist/index.js --input <输入文件> --output <输出文件> --language <目标语言> [选项]
 ```
 
-### 使用 npx
+### 使用npx
 
 ```bash
-npx ai-markdown-translator -i <input-file> -o <output-file> -l <target-language> [options]
+npx ai-markdown-translator -i <输入文件> -o <输出文件> -l <目标语言> [选项]
 ```
 
 例如：
@@ -83,93 +83,93 @@ npx ai-markdown-translator -i <input-file> -o <output-file> -l <target-language>
 npx ai-markdown-translator -u https://gitee.com/h7ml/ai-markdown-translator/raw/main/README.md -o output.md -l "Italian"
 ```
 
-### 使用独立可执行文件
+### 使用独立的可执行文件
 
 ```bash
-./ai-markdown-translator --input <input-file> --output <output-file> --language <target-language> [options]
+./ai-markdown-translator --input <输入文件> --output <输出文件> --language <目标语言> [选项]
 ```
 
 ## 选项
 
-- `--input`, `-i`: 输入 Markdown 文件（`--url` 的替代选项）。
-- `--url`, `-u`: 要翻译的 Markdown 文件的 URL（`--input` 的替代选项）。
-- `--output`, `-o`: 输出 Markdown 文件（必需）。
-- `--language`, `-l`: 翻译目标语言（必需）。
-- `--openai-url`: OpenAI API URL（默认：使用 `OPENAI_URL` 环境变量）。
-- `--api-key`: OpenAI API 密钥（默认：使用 `API_KEY` 环境变量）。
-- `--model`: 要使用的 OpenAI 模型（默认：使用 `MODEL` 环境变量或 `gpt-3.5-turbo`）。
-- `--help`, `-h`: 显示帮助。
-- `--show-version`, `-v`: 显示版本。
+- `--input`, `-i`：输入Markdown文件（`--url`的替代选项）。
+- `--url`, `-u`：要翻译的Markdown文件的URL（`--input`的替代选项）。
+- `--output`, `-o`：输出Markdown文件（如果未提供，则默认为输入文件名）。
+- `--language`, `-l`：翻译的目标语言（必需）。
+- `--openai-url`：OpenAI API URL (默认：使用 `OPENAI_URL` 环境变量）。
+- `--api-key`：OpenAI API密钥 (默认：使用 `API_KEY` 环境变量）。
+- `--model`：要使用的OpenAI模型 (默认：使用 `MODEL` 环境变量或 `gpt-3.5-turbo`）。
+- `--help`, `-h`：显示帮助。
+- `--show-version`, `-v`：显示版本。
 
-> 注意：`--input` 和 `--url` 是互斥的，你必须提供其中之一。
+> 注意：`--input` 和 `--url` 是互斥的；你必须提供其中之一。
 
 ## 环境变量
 
-可以设置以下环境变量，而不是将它们作为命令行参数传递：
+你可以设置以下环境变量，而不是将它们作为命令行参数传递：
 
-- `OPENAI_URL`: OpenAI API 的 URL。
-- `API_KEY`: 你的 OpenAI API 密钥。
-- `MODEL`: 要使用的 OpenAI 模型（例如，`'gpt-3.5-turbo'`）。
+- `OPENAI_URL`：OpenAI API的URL。
+- `API_KEY`：你的OpenAI API密钥。
+- `MODEL`：要使用的OpenAI模型（例如，`'gpt-3.5-turbo'`）。
 
-可以在项目根目录中的 `.env` 文件中设置这些变量，或者在你的 shell 中导出它们。
+你可以在项目根目录中的`.env`文件中设置这些变量，或者在你的shell中导出它们。
 
 ## 示例
 
-1. **将 Markdown 文件从英语翻译为西班牙语：**
+1. **将Markdown文件从英语翻译成西班牙语：**
 
 ```bash
 npx ai-markdown-translator -i english.md -o spanish.md -l "Spanish"
 ```
 
-2. **使用特定的 OpenAI 模型进行翻译：**
+2. **使用特定的OpenAI模型进行翻译：**
 
 ```bash
 npx ai-markdown-translator -i input.md -o output.md -l "French" --model "gpt-4"
 ```
 
-3. **使用自定义 OpenAI URL 和 API 密钥进行翻译：**
+3. **使用自定义的OpenAI URL和API密钥进行翻译：**
 
 ```bash
 npx ai-markdown-translator -i input.md -o output.md -l "German" --openai-url "https://api.302.ai/v1/chat/completions" --api-key "sk-302-api-key"
 ```
 
-4. **翻译 URL 的 Markdown 内容：**
+4. **翻译URL中的Markdown内容：**
 
 ```bash
 npx ai-markdown-translator -u https://gitee.com/h7ml/ai-markdown-translator/raw/main/README.md -o output.md -l "Italian"
 ```
 
 ## 许可证
 
-[MIT License](LICENSE)
+[MIT许可证](LICENSE)
 
-## Git 信息
+## Git信息
 
-- **仓库**: [h7ml/ai-markdown-translator](https://github.com/h7ml/ai-markdown-translator)
-- **问题**: [报告问题](https://github.com/h7ml/ai-markdown-translator/issues)
+- **仓库**：[h7ml/ai-markdown-translator](https://github.com/h7ml/ai-markdown-translator)
+- **问题**：[报告问题](https://github.com/h7ml/ai-markdown-translator/issues)
 
 ## 版本信息
 
-- **当前版本**: 1.0.6
-- **NPM 包**: [ai-markdown-translator](https://www.npmjs.com/package/ai-markdown-translator)
+- **当前版本**：1.0.6
+- **NPM包**：[ai-markdown-translator](https://www.npmjs.com/package/ai-markdown-translator)
 
-## CI 信息
+## CI信息
 
-此项目使用 GitHub Actions 进行持续集成。CI 工作流包括：
+此项目使用GitHub Actions进行持续集成。CI工作流包括：
 
-- 使用 ESLint 检查代码
+- 使用ESLint对代码进行linting
 - 运行测试（如果适用）
 - 构建项目
-- 缓存依赖项以加快构建速度
+- 缓存依赖以加速构建
 
 ## 贡献
 
-欢迎贡献！请随时提交拉取请求。
+欢迎贡献！请随时提交Pull Request。
 
 ## 支持
 
-如果遇到任何问题或有任何问题，请在此存储库中提出问题。
+如果你遇到任何问题或有任何问题，请在这个仓库中打开一个issue。
 
 ---
 
-此版本结合了 `npx` 和独立可执行文件（`./ai-markdown-translator`）的使用示例，让我知道您是否希望做进一步的调整！
+这个版本将 `npx` 和独立可执行文件 (`./ai-markdown-translator`) 的使用示例合并成了一个连贯的部分。如果你想进行任何进一步的调整，请告诉我！
diff --git a/README.md b/README.md
@@ -93,7 +93,7 @@ npx ai-markdown-translator -u https://gitee.com/h7ml/ai-markdown-translator/raw/
 
 - `--input`, `-i`: Input Markdown file (alternative to `--url`).
 - `--url`, `-u`: URL of a Markdown file to translate (alternative to `--input`).
-- `--output`, `-o`: Output Markdown file (required).
+- `--output`, `-o`: Output Markdown file (if not provided, defaults to the input file name).
 - `--language`, `-l`: Target language for translation (required).
 - `--openai-url`: OpenAI API URL (default: uses `OPENAI_URL` environment variable).
 - `--api-key`: OpenAI API Key (default: uses `API_KEY` environment variable).
diff --git a/src/index.ts b/src/index.ts
@@ -233,7 +233,6 @@ async function main() {
       alias: 'o',
       description: '输出的Markdown文件',
       type: 'string',
-      demandOption: true,
     })
     .option('language', {
       alias: 'l',
@@ -295,6 +294,14 @@ async function main() {
       markdownContent = markdownContent.slice(0, -3).trim();
     }
 
+    if (!argv.output && argv.input) {
+      argv.output = argv.input;
+    }
+
+    if (typeof argv.output !== 'string') {
+      throw new Error('输出文件名无效。');
+    }
+
     const translatedContent = await translateText(
       markdownContent,
       argv.language,
@@ -304,7 +311,20 @@ async function main() {
     );
 
     if (translatedContent) {
-      writeMarkdownFile(argv.output, translatedContent);
+      let modifiedContent = translatedContent; // Create a mutable variable
+      // 校验下第一行是否含有```  和 最后是否含有``` 如果是的话 那么删掉第一行和最后行
+      if (modifiedContent.startsWith('```')) {
+        const endOfFirstLine = modifiedContent.indexOf('\n');
+        // 删除整行代码块标记（包括```和可能的语言标识符）
+        modifiedContent = modifiedContent.slice(endOfFirstLine + 1).trim();
+      }
+
+      if (modifiedContent.endsWith('```')) {
+        const startOfLastLine = modifiedContent.lastIndexOf('\n');
+        // 删除整行代码块标记
+        modifiedContent = modifiedContent.slice(0, startOfLastLine).trim();
+      }
+      writeMarkdownFile(argv.output, modifiedContent);
       console.log(`翻译完成。输出已保存到 ${argv.output}。`);
     } else {
       console.log('翻译失败。');
