Tanu.js 项目使用教程

1. 项目目录结构及介绍

Tanu.js 是一个简化 TypeScript 编译器 API 的项目，用于定义和生成源文件。项目目录结构如下：

tanu.js/
├── .github/               # GitHub 工作流目录
│   └── workflows/
├── src/                   # 源代码目录
├── test/                  # 测试代码目录
├── .eslintrc.js           # ESLint 配置文件
├── .gitignore             # Git 忽略文件
├── .nycrc                 # NYL 完整性检查配置文件
├── LICENSE.md             # 开源许可证文件
├── README.md              # 项目说明文件
├── package.json           # 项目配置文件
└── tsconfig.json          # TypeScript 配置文件

• .github/workflows/：存放 GitHub Actions 工作流文件，用于自动化处理如代码提交、构建、测试等任务。
• src/：存放项目的源代码，包括 TypeScript 接口定义和类型声明。
• test/：存放项目的测试代码。
• .eslintrc.js：ESLint 配置文件，用于定义代码风格规则。
• .gitignore：Git 忽略文件，用于指定不需要提交到 Git 仓库的文件和目录。
• .nycrc：NYL 完整性检查配置文件，用于配置测试覆盖率检查。
• LICENSE.md：项目开源许可证文件，本项目采用 MIT 许可证。
• README.md：项目说明文件，介绍项目的基本信息和如何使用。
• package.json：项目配置文件，定义了项目的依赖、脚本和其他元数据。
• tsconfig.json：TypeScript 配置文件，定义了 TypeScript 编译器的选项。

2. 项目的启动文件介绍

在 Tanu.js 项目中，并没有一个明确的启动文件。项目的主要功能是通过 tanu 对象定义接口，然后使用 generate 方法生成 TypeScript 源文件。以下是一个基本的使用示例：

import { t } from 'tanu.js';

const User = t.interface('User', {
  id: t.number(),
  email: t.string(),
  name: t.optional({
    first: t.string(),
    last: t.string(),
  }),
});

const result = await t.generate([User]);
console.log(result);

在这个示例中，我们首先导入了 tanu.js 中的 t 对象，然后定义了一个名为 User 的接口。最后，我们调用 generate 方法来生成 TypeScript 源文件。

3. 项目的配置文件介绍

项目的配置文件主要包括以下两个：

• package.json
• tsconfig.json

package.json

package.json 文件定义了项目的依赖和脚本。以下是一些关键的配置项：

{
  "name": "tanu.js",
  "version": "1.0.0",
  "description": "An oversimplification of the TypeScript Compiler API for defining and generating source files.",
  "main": "dist/tanu.js",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    "typescript": "^4.0.0"
  },
  "devDependencies": {
    "jest": "^26.6.3",
    "typescript": "^4.0.0"
  }
}

在这个文件中，scripts 对象定义了项目的构建和测试脚本。例如，build 脚本使用 TypeScript 编译器 (tsc) 来编译项目，而 test 脚本使用 Jest 来运行测试。

tsconfig.json

tsconfig.json 文件定义了 TypeScript 编译器的选项。以下是一个示例：

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist"]
}

在这个文件中，compilerOptions 对象定义了编译器的各种选项，例如目标代码版本 (target)、模块系统 (module) 和严格的类型检查 (strict)。include 和 exclude 数组定义了编译器应该包含和排除的文件和目录。