Crowdin CLI 项目教程

1. 项目的目录结构及介绍

Crowdin CLI 项目的目录结构如下：

crowdin-cli/
├── bin/
│   ├── crowdin-cli
│   └── crowdin-cli.bat
├── lib/
│   ├── crowdin-cli.jar
│   └── ...
├── src/
│   ├── main/
│   │   ├── java/
│   │   └── resources/
│   └── test/
│       ├── java/
│       └── resources/
├── .gitignore
├── LICENSE
├── README.md
└── ...

目录结构介绍

• bin/: 包含 Crowdin CLI 的可执行文件，适用于不同操作系统（如 crowdin-cli 适用于 Unix 系统，crowdin-cli.bat 适用于 Windows 系统）。
• lib/: 包含 Crowdin CLI 的核心 JAR 文件 crowdin-cli.jar，以及其他依赖库。
• src/: 包含项目的源代码，分为 main/ 和 test/ 两个部分。main/ 目录下是主要的 Java 代码和资源文件，test/ 目录下是测试代码和资源文件。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• LICENSE: 项目的开源许可证文件，Crowdin CLI 使用 MIT 许可证。
• README.md: 项目的说明文档，包含项目的基本信息、安装方法、使用说明等。

2. 项目的启动文件介绍

Crowdin CLI 的启动文件位于 bin/ 目录下，分别是 crowdin-cli 和 crowdin-cli.bat。

crowdin-cli

这是一个适用于 Unix 系统的启动脚本，通常是一个 shell 脚本。它负责设置环境变量并调用 lib/ 目录下的 crowdin-cli.jar 文件来启动 Crowdin CLI。

crowdin-cli.bat

这是一个适用于 Windows 系统的启动脚本，是一个批处理文件。它同样负责设置环境变量并调用 lib/ 目录下的 crowdin-cli.jar 文件来启动 Crowdin CLI。

3. 项目的配置文件介绍

Crowdin CLI 的配置文件通常是一个 YAML 文件，名为 crowdin.yml 或 crowdin.yaml。这个文件用于配置 Crowdin CLI 的行为，包括项目的基本信息、源文件路径、目标语言等。

配置文件示例

project_id: 'your_project_id'
api_token: 'your_api_token'
base_path: '/path/to/your/project'

files:
  - source: '/source/file.json'
    translation: '/translations/%two_letters_code%/%original_file_name%'

配置文件字段介绍

• project_id: 你的 Crowdin 项目的唯一标识符。
• api_token: 你的 Crowdin API 令牌，用于身份验证。
• base_path: 你的项目根目录路径。
• files: 定义需要上传或下载的文件及其路径。source 字段指定源文件路径，translation 字段指定翻译文件的保存路径。

通过配置文件，你可以灵活地管理你的本地化资源，并与 Crowdin 项目同步。