Theatre.js 项目教程

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

Theatre.js 项目的目录结构如下：

theatre/
├── compat-tests/
├── devEnv/
├── examples/
├── packages/
├── .editorconfig
├── .eslintignore
├── .eslintrc.js
├── .gitignore
├── .prettierignore
├── .prettierrc
├── .yarnrc.yml
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── Notes.md
├── README.md
├── credits.txt
├── docker-compose.yml
├── jest.compat-tests.config.js
├── jest.config.js
├── knip.config.json
├── lerna.json
├── package.json
├── render.yaml
├── tsconfig.base.json
├── wallaby.conf.js
└── yarn.lock

目录结构介绍

• compat-tests/: 兼容性测试相关文件。
• devEnv/: 开发环境相关文件。
• examples/: 示例代码和项目。
• packages/: 项目的主要代码包。
• .editorconfig: 编辑器配置文件。
• .eslintignore: ESLint 忽略文件。
• .eslintrc.js: ESLint 配置文件。
• .gitignore: Git 忽略文件。
• .prettierignore: Prettier 忽略文件。
• .prettierrc: Prettier 配置文件。
• .yarnrc.yml: Yarn 配置文件。
• CHANGELOG.md: 项目更新日志。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• Notes.md: 项目笔记。
• README.md: 项目介绍和使用说明。
• credits.txt: 项目贡献者名单。
• docker-compose.yml: Docker 配置文件。
• jest.compat-tests.config.js: Jest 兼容性测试配置文件。
• jest.config.js: Jest 配置文件。
• knip.config.json: Knip 配置文件。
• lerna.json: Lerna 配置文件。
• package.json: 项目依赖和脚本配置文件。
• render.yaml: 渲染配置文件。
• tsconfig.base.json: TypeScript 基础配置文件。
• wallaby.conf.js: Wallaby.js 配置文件。
• yarn.lock: Yarn 锁定文件。

2. 项目的启动文件介绍

Theatre.js 项目的启动文件主要集中在 packages/ 目录下。具体启动文件可能因项目的具体实现而异，但通常会包含以下几个关键文件：

• packages/core/src/index.ts: 核心包的入口文件，负责初始化和启动核心功能。
• packages/studio/src/index.ts: 工作室包的入口文件，负责初始化和启动编辑器功能。

这些文件通常会导出主要的 API 和功能模块，供其他模块或外部应用调用。

3. 项目的配置文件介绍

Theatre.js 项目的配置文件主要用于配置开发环境、测试环境和构建工具。以下是一些关键的配置文件及其作用：

• .eslintrc.js: ESLint 配置文件，用于定义代码风格和规则。
• .prettierrc: Prettier 配置文件，用于格式化代码。
• jest.config.js: Jest 配置文件，用于配置单元测试和集成测试。
• knip.config.json: Knip 配置文件，用于管理项目依赖。
• lerna.json: Lerna 配置文件，用于管理多包项目。
• tsconfig.base.json: TypeScript 基础配置文件，定义 TypeScript 编译选项。
• wallaby.conf.js: Wallaby.js 配置文件，用于实时测试和调试。
• yarn.lock: Yarn 锁定文件，确保依赖版本一致性。

这些配置文件共同作用，确保项目在开发、测试和构建过程中的一致性和稳定性。