Orval 项目使用教程

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

Orval 项目的目录结构如下：

orval/
├── docs/
├── packages/
├── samples/
├── tests/
├── types/
├── .eslintrc.js
├── .gitignore
├── .lintstagedrc.json
├── .node-version
├── .npmignore
├── .nvmrc
├── .prettierignore
├── .prettierrc.json
├── .release-it.json
├── .yarnrc.yml
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── commitlint.config.js
├── package.json
├── tsconfig.base.json
├── turbo.json
└── yarn.lock

目录结构介绍

• docs/: 存放项目的文档文件。
• packages/: 存放项目的核心代码包。
• samples/: 存放项目的示例代码。
• tests/: 存放项目的测试代码。
• types/: 存放项目的类型定义文件。
• .eslintrc.js: ESLint 配置文件。
• .gitignore: Git 忽略文件配置。
• .lintstagedrc.json: lint-staged 配置文件。
• .node-version: Node.js 版本配置。
• .npmignore: npm 忽略文件配置。
• .nvmrc: nvm 版本配置。
• .prettierignore: Prettier 忽略文件配置。
• .prettierrc.json: Prettier 配置文件。
• .release-it.json: release-it 配置文件。
• .yarnrc.yml: Yarn 配置文件。
• CODE_OF_CONDUCT.md: 项目行为准则。
• CONTRIBUTING.md: 项目贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• commitlint.config.js: commitlint 配置文件。
• package.json: 项目依赖和脚本配置。
• tsconfig.base.json: TypeScript 基础配置文件。
• turbo.json: Turbo 配置文件。
• yarn.lock: Yarn 锁定文件。

2. 项目的启动文件介绍

Orval 项目的启动文件主要依赖于 package.json 中的脚本配置。以下是一些常用的启动命令：

• 开发模式启动:

  yarn dev
  

• 生产模式启动:

  yarn start
  

• 构建项目:

  yarn build
  

这些命令的具体实现可以在 package.json 中的 scripts 部分找到。

3. 项目的配置文件介绍

3.1 .eslintrc.js

ESLint 配置文件，用于定义代码风格和规则。

3.2 .prettierrc.json

Prettier 配置文件，用于代码格式化。

3.3 commitlint.config.js

commitlint 配置文件，用于规范 Git 提交信息。

3.4 tsconfig.base.json

TypeScript 基础配置文件，定义 TypeScript 编译选项。

3.5 turbo.json

Turbo 配置文件，用于管理项目的构建和任务执行。

3.6 package.json

项目依赖和脚本配置文件，包含项目的依赖包、脚本命令等信息。

3.7 yarn.lock

Yarn 锁定文件，用于确保项目依赖的一致性。

通过以上配置文件，可以对 Orval 项目进行代码风格检查、代码格式化、Git 提交信息规范、TypeScript 编译等操作。