Univer 开源项目使用教程

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

Univer 项目的目录结构如下：

univer/
├── docs/
├── examples/
├── packages/
│   ├── base-component/
│   ├── common/
│   ├── core/
│   ├── design/
│   ├── editor/
│   ├── engine/
│   ├── framework/
│   ├── plugin/
│   ├── renderer/
│   ├── shared/
│   ├── theme/
│   ├── ui/
│   └── utils/
├── scripts/
├── src/
├── tests/
├── .gitignore
├── .npmrc
├── .prettierrc
├── babel.config.js
├── jest.config.js
├── lerna.json
├── package.json
├── tsconfig.json
└── README.md

目录结构介绍

• docs/: 包含项目的文档文件。
• examples/: 包含项目的示例代码。
• packages/: 包含项目的各个模块，如基础组件、核心功能、插件等。
• scripts/: 包含项目的脚本文件。
• src/: 包含项目的主要源代码。
• tests/: 包含项目的测试代码。
• .gitignore: Git 忽略文件配置。
• .npmrc: npm 配置文件。
• .prettierrc: Prettier 代码格式化配置。
• babel.config.js: Babel 配置文件。
• jest.config.js: Jest 测试配置文件。
• lerna.json: Lerna 多包管理配置文件。
• package.json: 项目的 npm 配置文件。
• tsconfig.json: TypeScript 配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

Univer 项目的启动文件主要位于 src/ 目录下。以下是一些关键的启动文件：

• src/index.ts: 项目的入口文件，负责初始化项目和启动应用。
• src/main.ts: 主应用文件，包含应用的主要逻辑。
• src/app.ts: 应用配置文件，包含应用的配置信息和初始化设置。

启动文件介绍

• index.ts: 该文件是项目的入口点，负责导入和初始化各个模块，并启动应用。
• main.ts: 该文件包含应用的主要逻辑，如路由配置、服务初始化等。
• app.ts: 该文件包含应用的配置信息，如环境变量、插件配置等。

3. 项目的配置文件介绍

Univer 项目的配置文件主要位于项目根目录下。以下是一些关键的配置文件：

• package.json: 包含项目的依赖、脚本命令和其他配置信息。
• tsconfig.json: TypeScript 编译配置文件，定义 TypeScript 编译选项。
• babel.config.js: Babel 配置文件，定义 JavaScript 转译选项。
• jest.config.js: Jest 测试配置文件，定义测试框架的配置选项。
• lerna.json: Lerna 多包管理配置文件，用于管理多个 npm 包。

配置文件介绍

• package.json: 该文件包含项目的依赖、脚本命令和其他配置信息，如启动命令、构建命令等。
• tsconfig.json: 该文件定义 TypeScript 编译选项，如编译目标、模块系统、严格模式等。
• babel.config.js: 该文件定义 JavaScript 转译选项，如预设、插件等。
• jest.config.js: 该文件定义测试框架的配置选项，如测试环境、测试匹配器等。
• lerna.json: 该文件用于管理多个 npm 包，定义包的版本、发布策略等。

以上是 Univer 开源项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用 Univer 项目。