WebTranslateIt 同步工具 (wti) 技术文档

1. 安装指南

1.1 系统要求

• Ruby 版本: 2.6 或更高版本。
• 操作系统: Windows、Linux、MacOS X 等。

1.2 安装步骤

1. 安装 Ruby:

   • Linux/MacOS: 通常已经预装了 Ruby。如果没有，请通过包管理器安装。
   • Windows: 使用 RubyInstaller 安装 Ruby。

2. 安装 wti:

   $ gem install web_translate_it
   

   安装完成后，可以通过以下命令验证安装是否成功：

   $ wti -v
   wti version 2.6.4
   

3. Docker 安装:

   • 如果你更喜欢使用 Docker，可以参考 Docker 安装指南。

2. 项目使用说明

2.1 初始化项目

在项目根目录下运行以下命令来初始化项目：

$ wti init proj_pvt_V8skdjsdDDA4

其中 proj_pvt_V8skdjsdDDA4 是你的 API 令牌，可以在项目设置中找到。

2.2 常用命令

• 拉取翻译文件:

  $ wti pull
  

• 推送主语言文件:

  $ wti push
  

• 查看项目状态:

  $ wti status
  

2.3 多项目同步

如果你需要在多个项目中使用 wti，请参考 多项目同步文档。

3. 项目 API 使用文档

3.1 基本命令

• 拉取目标语言文件:

  $ wti pull
  

• 推送主语言文件:

  $ wti push
  

• 添加新语言文件:

  $ wti add path/to/master/file.po
  

• 添加新语言:

  $ wti addlocale fr
  

3.2 高级选项

• 强制推送:

  $ wti push --force
  

• 强制拉取:

  $ wti pull --force
  

• 查看文件匹配情况:

  $ wti match
  

4. 项目安装方式

4.1 通过 Ruby Gem 安装

$ gem install web_translate_it

4.2 通过 Docker 安装

参考 Docker 安装指南。

4.3 配置文件

wti 会在项目根目录下查找 .wti 文件。你可以通过以下命令创建配置文件：

$ wti init proj_pvt_V8skdjsdDDA4

5. 示例命令

命令	操作
wti add path/to/master/file.po	上传新的主语言文件
wti push	更新主语言文件
wti pull	下载目标语言文件
wti addlocale fr	添加新语言到项目
wti status	查看项目翻译统计

6. Hooks

你可以在 .wti 文件中设置 Hooks，以便在推送或拉取前后执行特定命令。

6.1 可用 Hooks

• before_pull
• after_pull
• before_push
• after_push

6.2 示例

before_pull: "echo '开始拉取文件'"
after_pull: "echo '文件拉取完成'"

7. 退出代码

wti 在命令执行失败时会返回退出代码：

• 0: 命令执行成功。
• 1: 命令执行但遇到至少一个错误。
• 100: 项目未完全翻译。
• 101: 项目未完全校对。