i18n-auto-translation 项目启动与配置教程

i18n-auto-translation 项目启动与配置教程

i18n-auto-translation Auto translate i18n JSON file(s) to desired language(s). 项目地址: https://gitcode.com/gh_mirrors/i1/i18n-auto-translation

1. 项目目录结构及介绍

i18n-auto-translation 项目是一个用于自动翻译 i18n JSON 文件的工具。项目的目录结构如下：

.
├── .github
├── .gitignore
├── .npmrc
├── .prettierignore
├── .prettierrc.js
├── LICENSE
├── README.md
├── eslint.config.mjs
├── package-lock.json
├── package.json
├── tsconfig.build.json
├── tsconfig.json
├── vitest.config.ts
├── src
│   ├── ...
├── tests
│   ├── ...

• .github: 存放与 GitHub 相关的配置文件。
• .gitignore: 定义哪些文件和目录应该被 Git 忽略。
• .npmrc: NPM 的配置文件。
• .prettierignore: 定义哪些文件应该被 Prettier 忽略。
• .prettierrc.js: Prettier 的配置文件。
• LICENSE: 项目的许可证文件，本项目使用 MIT 许可。
• README.md: 项目的说明文档。
• eslint.config.mjs: ESLint 的配置文件。
• package-lock.json: NPM 的依赖锁定文件。
• package.json: 定义项目的元数据和依赖。
• tsconfig.build.json 和 tsconfig.json: TypeScript 的配置文件。
• vitest.config.ts: Vitest 测试框架的配置文件。
• src: 源代码目录。
• tests: 测试代码目录。

2. 项目的启动文件介绍

项目的启动主要通过 package.json 文件中的脚本实现。以下是一些主要的启动脚本：

"scripts": {
  "start": "ts-node ./src/index.ts",
  "build": "tsc",
  "test": "vitest"
}

• start: 使用 ts-node 直接运行 src/index.ts 文件，用于开发时的快速启动。
• build: 使用 TypeScript 编译器 tsc 将 TypeScript 代码编译为 JavaScript 代码。
• test: 使用 Vitest 测试框架运行测试。

你可以通过以下命令启动项目：

npm start

3. 项目的配置文件介绍

项目的配置文件包括但不限于以下几项：

• tsconfig.json: TypeScript 配置文件，定义了 TypeScript 编译器的选项，例如包含的文件、排除的文件、编译选项等。

{
  "include": ["src/**/*"],
  "exclude": ["node_modules", "**/*.spec.ts"],
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "strict": true,
    ...
  }
}

• vitest.config.ts: Vitest 测试框架的配置文件，用于配置测试环境、测试选项等。

import { defineConfig } from 'vitest/config';

export default defineConfig({
  testEnvironment: 'node',
  ...
});

• .prettierrc.js: Prettier 的配置文件，用于定义代码风格规范。

module.exports = {
  semi: false,
  trailingComma: 'es5',
  singleQuote: true,
  ...
};

以上是 i18n-auto-translation 项目的启动与配置的基础教程，希望对您有所帮助。

i18n-auto-translation Auto translate i18n JSON file(s) to desired language(s). 项目地址: https://gitcode.com/gh_mirrors/i1/i18n-auto-translation