Firefox Translations 项目教程
1. 项目目录结构及介绍
firefox-translations/
├── docs/
├── extension/
│ ├── controller/
│ ├── model/
│ └── scripts/
├── scripts/
├── .eslintrc.js
├── .gitignore
├── .gitmodules
├── taskcluster.yml
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── LICENSE
├── README.md
├── package-lock.json
├── package.json
└── update.json
目录结构介绍
- docs/: 包含项目的文档文件。
- extension/: 包含浏览器扩展的核心代码。
- controller/: 控制器代码,处理翻译逻辑。
- model/: 数据模型和静态资源。
- scripts/: 扩展的脚本文件。
- scripts/: 包含项目的脚本文件,用于自动化任务。
- .eslintrc.js: ESLint 配置文件,用于代码风格检查。
- .gitignore: Git 忽略文件配置。
- .gitmodules: Git 子模块配置。
- taskcluster.yml: Taskcluster 配置文件,用于 CI/CD。
- CHANGELOG.md: 项目更新日志。
- CODE_OF_CONDUCT.md: 项目行为准则。
- LICENSE: 项目许可证。
- README.md: 项目介绍和使用说明。
- package-lock.json: npm 锁定文件,确保依赖版本一致。
- package.json: npm 配置文件,包含项目依赖和脚本。
- update.json: 更新配置文件。
2. 项目启动文件介绍
启动文件
- extension/scripts/update-telemetry-schema.sh: 用于更新遥测模式的脚本。
- extension/scripts/update-bergamot-translator.sh: 用于更新 Bergamot 翻译器的脚本。
启动步骤
-
安装依赖:
npm install
-
运行项目:
npm run once
-
配置实验扩展: 在 Firefox Nightly 中,访问
about:config
并设置以下首选项:xpinstall.signatures.required
设置为false
extensions.experiments.enabled
设置为true
-
浏览网页: 访问支持的语言页面,翻译选项将自动出现。
3. 项目配置文件介绍
配置文件
- .eslintrc.js: 代码风格检查配置。
- package.json: 项目依赖和脚本配置。
- taskcluster.yml: CI/CD 配置。
- update.json: 更新配置。
配置文件介绍
- .eslintrc.js: 配置 ESLint 规则,确保代码风格一致。
- package.json: 包含项目的依赖包和脚本命令,如
npm run once
用于启动项目。 - taskcluster.yml: 配置 Taskcluster 任务,用于自动化构建和部署。
- update.json: 配置更新信息,确保用户可以获取最新版本。
通过以上步骤,您可以顺利启动和配置 Firefox Translations 项目,并了解其目录结构和关键配置文件的作用。