OpenJSCAD.org 项目教程

2024-09-19 18:17:00作者：伍希望

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

OpenJSCAD.org 是一个用于创建参数化 2D 和 3D 设计的开源项目，使用 JavaScript 编写。项目的目录结构如下：

OpenJSCAD.org/
├── packages/
│   ├── @jscad/
│   │   ├── core/
│   │   ├── io/
│   │   ├── modeling/
│   │   ├── regl-renderer/
│   │   ├── utils/
│   │   └── ...
│   └── ...
├── .gitignore
├── .npmignore
├── .travis.yml
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── coverage_reports/
├── jsdoc.json
├── lerna.json
├── package.json
└── ...

目录结构介绍

packages/: 包含所有 JSCAD 的核心模块和工具包。每个子目录都是一个独立的 NPM 包，可以单独使用。
- @jscad/core/: 核心库，包含基本的 2D 和 3D 几何操作。
- @jscad/io/: 输入输出模块，支持多种文件格式的导入和导出。
- @jscad/modeling/: 建模工具，提供高级的几何操作和变换。
- @jscad/regl-renderer/: 渲染器，用于在浏览器中渲染 3D 模型。
- @jscad/utils/: 实用工具库，包含一些辅助函数和工具。
.gitignore: Git 忽略文件，指定哪些文件和目录不需要被版本控制。
.npmignore: NPM 忽略文件，指定哪些文件和目录不需要被发布到 NPM。
.travis.yml: Travis CI 配置文件，用于持续集成和自动化测试。
CHANGELOG.md: 项目更新日志，记录每个版本的变更内容。
CODE_OF_CONDUCT.md: 行为准则，规定了项目社区的行为规范。
CONTRIBUTING.md: 贡献指南，指导开发者如何为项目贡献代码。
LICENSE: 项目许可证，本项目使用 MIT 许可证。
README.md: 项目说明文档，包含项目的基本信息和使用指南。
coverage_reports/: 代码覆盖率报告，用于测试代码的覆盖情况。
jsdoc.json: JSDoc 配置文件，用于生成 API 文档。
lerna.json: Lerna 配置文件，用于管理多包项目。
package.json: 项目的 NPM 配置文件，包含项目的依赖、脚本等信息。

2. 项目的启动文件介绍

OpenJSCAD.org 项目的主要启动文件是 packages/@jscad/web/src/index.js。这个文件是 Web 版本的入口文件，负责初始化 Web 界面并加载用户的设计代码。

启动文件介绍

index.js: 这是 Web 版本的入口文件，负责初始化 Web 界面并加载用户的设计代码。它包含了主要的逻辑，如渲染 3D 模型、处理用户输入、加载和保存设计文件等。

3. 项目的配置文件介绍

OpenJSCAD.org 项目的配置文件主要包括 package.json 和 lerna.json。

配置文件介绍

package.json: 这是 NPM 的配置文件，包含了项目的依赖、脚本、版本信息等。通过这个文件，可以管理项目的依赖包、运行脚本、发布包等。

{
  "name": "openjscad",
  "version": "2.0.0",
  "description": "OpenJSCAD.org",
  "main": "index.js",
  "scripts": {
    "start": "node index.js",
    "test": "jest"
  },
  "dependencies": {
    "@jscad/core": "^2.0.0",
    "@jscad/io": "^2.0.0",
    "@jscad/modeling": "^2.0.0",
    "@jscad/regl-renderer": "^2.0.0",
    "@jscad/utils": "^2.0.0"
  },
  "devDependencies": {
    "jest": "^26.0.0"
  }
}

lerna.json: 这是 Lerna 的配置文件，用于管理多包项目。Lerna 是一个工具，可以帮助开发者管理多个 NPM 包，并自动处理包之间的依赖关系。
```
{
  "version": "2.0.0",
  "npmClient": "npm",
  "packages": [
    "packages/*"
  ],
  "useWorkspaces": true
}
```