enable3d 项目教程

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

enable3d 项目的目录结构如下：

enable3d/
├── bundles/
├── packages/
├── readme/
├── scripts/
├── test/
├── webpack/
├── .eslintignore
├── .eslintrc
├── .gitignore
├── .prettierrc
├── LICENSE
├── README.md
├── WebXR.md
├── getChanges.sh
├── jest-puppeteer.config.js
├── jest.config.js
├── lerna.json
├── package-lock.json
├── package.json
├── prune.md
├── prune.ps1
└── tsconfig.base.json

目录结构介绍

• bundles/: 包含项目的打包文件。
• packages/: 包含项目的各个 npm 包，如 @enable3d/ammo-physics、@enable3d/three-graphics 等。
• readme/: 包含项目的 README 文件。
• scripts/: 包含项目的脚本文件。
• test/: 包含项目的测试文件。
• webpack/: 包含项目的 Webpack 配置文件。
• .eslintignore: ESLint 忽略文件。
• .eslintrc: ESLint 配置文件。
• .gitignore: Git 忽略文件。
• .prettierrc: Prettier 配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目的主 README 文件。
• WebXR.md: 关于 WebXR 的说明文件。
• getChanges.sh: 获取变更的脚本文件。
• jest-puppeteer.config.js: Jest Puppeteer 配置文件。
• jest.config.js: Jest 配置文件。
• lerna.json: Lerna 配置文件。
• package-lock.json: npm 包锁定文件。
• package.json: npm 包配置文件。
• prune.md: 关于修剪的说明文件。
• prune.ps1: 修剪的 PowerShell 脚本文件。
• tsconfig.base.json: TypeScript 基础配置文件。

2. 项目的启动文件介绍

enable3d 项目的启动文件主要是 package.json 中的 scripts 部分。以下是一些关键的启动脚本：

{
  "scripts": {
    "start": "webpack serve --config webpack/webpack.config.js",
    "build": "webpack --config webpack/webpack.config.js",
    "test": "jest"
  }
}

启动文件介绍

• start: 使用 Webpack 启动开发服务器，配置文件为 webpack/webpack.config.js。
• build: 使用 Webpack 构建项目，配置文件为 webpack/webpack.config.js。
• test: 使用 Jest 运行测试。

3. 项目的配置文件介绍

enable3d 项目中有多个配置文件，以下是一些关键的配置文件及其介绍：

3.1 webpack/webpack.config.js

Webpack 配置文件，用于项目的构建和开发服务器的启动。

3.2 jest.config.js

Jest 配置文件，用于项目的测试配置。

3.3 tsconfig.base.json

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

3.4 .eslintrc

ESLint 配置文件，用于代码风格检查和错误检测。

3.5 lerna.json

Lerna 配置文件，用于管理多包项目。

3.6 package.json

npm 包配置文件，包含了项目的依赖、脚本、版本等信息。

通过以上配置文件，enable3d 项目能够实现代码的构建、测试、代码风格检查等功能。