GPT Translate 项目使用教程

1. 项目目录结构及介绍

gpt-translate/
├── dist/
│   └── ... (编译后的文件)
├── scripts/
│   └── ... (脚本文件)
├── src/
│   └── ... (源代码文件)
├── website/
│   └── ... (项目网站相关文件)
├── .gitignore
├── .prettierrc.yml
├── LICENSE
├── README.md
├── action.yml
├── package.json
├── tsconfig.json
└── yarn.lock

目录结构说明

• dist/: 存放编译后的文件。
• scripts/: 存放项目的脚本文件。
• src/: 存放项目的源代码文件。
• website/: 存放项目网站相关的文件。
• .gitignore: Git 忽略文件配置。
• .prettierrc.yml: Prettier 代码格式化配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• action.yml: GitHub Actions 配置文件。
• package.json: 项目依赖和脚本配置文件。
• tsconfig.json: TypeScript 配置文件。
• yarn.lock: Yarn 依赖锁定文件。

2. 项目启动文件介绍

项目的主要启动文件是 action.yml，这是一个 GitHub Actions 配置文件，用于定义工作流程。该文件定义了如何触发和执行翻译操作。

action.yml 文件内容概览

name: GPT Translate
on:
  issue_comment:
    types: [created]
jobs:
  gpt_translate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run GPT Translate
        if: |
          contains(github.event.comment.body, '/gpt-translate') ||
          contains(github.event.comment.body, '/gt')
        uses: 3ru/gpt-translate@master
        with:
          apikey: $[[ secrets.OPENAI_API_KEY ]]

启动流程说明

1. 触发条件: 当在 GitHub 仓库的 Issue 或 Pull Request 中创建包含 /gpt-translate 或 /gt 的评论时，触发工作流程。
2. 执行步骤:
   • 使用 actions/checkout@v4 检出代码。
   • 运行 3ru/gpt-translate@master 操作，并传递 OPENAI_API_KEY 作为 API 密钥。

3. 项目的配置文件介绍

1. .gitignore

该文件用于指定 Git 应该忽略的文件和目录，避免将不必要的文件提交到版本控制中。

2. .prettierrc.yml

Prettier 配置文件，用于定义代码格式化的规则，确保代码风格一致。

3. LICENSE

项目的许可证文件，定义了项目的开源许可证类型。

4. README.md

项目的说明文档，包含了项目的介绍、使用方法、贡献指南等信息。

5. action.yml

GitHub Actions 配置文件，定义了工作流程的触发条件和执行步骤。

6. package.json

Node.js 项目的配置文件，包含了项目的依赖、脚本命令等信息。

7. tsconfig.json

TypeScript 配置文件，定义了 TypeScript 编译器的选项和项目结构。

8. yarn.lock

Yarn 依赖锁定文件，确保项目在不同环境中安装相同的依赖版本。

通过以上配置文件，项目可以实现代码格式化、依赖管理、工作流程自动化等功能。