ProseMirror 项目教程

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

ProseMirror 项目的目录结构如下：

prosemirror/
├── assets/
├── bin/
├── demo/
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── package.json
└── tsconfig.json

目录结构介绍

• assets/: 存放项目相关的静态资源文件。
• bin/: 包含用于开发和构建项目的脚本文件。
• demo/: 包含项目的演示代码和示例。
• .gitignore: Git 忽略文件，指定哪些文件和目录不需要被 Git 跟踪。
• CONTRIBUTING.md: 贡献指南，指导开发者如何为项目做出贡献。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的主文档，包含项目的概述、安装和使用说明。
• package.json: Node.js 项目的配置文件，包含项目的依赖、脚本等信息。
• tsconfig.json: TypeScript 项目的配置文件，定义 TypeScript 编译选项。

2. 项目的启动文件介绍

ProseMirror 项目的启动文件主要集中在 bin/ 目录下。以下是一些关键的启动脚本：

• bin/pm: 这是一个主要的脚本文件，提供了多种功能来管理项目的开发和构建过程。
  • bin/pm install: 安装所有子模块的依赖并构建它们。
  • bin/pm build: 重新构建所有模块。
  • bin/pm watch: 设置一个监听进程，当模块发生变化时自动重新构建。
  • bin/pm status: 打印所有子模块的 Git 状态。
  • bin/pm commit <args>: 在所有有待处理更改的子模块中运行 git commit。
  • bin/pm test: 运行所有模块的（非浏览器）测试。
  • bin/pm push: 在所有模块中运行 git push。
  • bin/pm grep <pattern>: 在所有模块的源代码中搜索给定的模式。
  • bin/pm dev-start: 启动一个服务器，当源代码发生变化时重新构建包，并在端口 8080 上公开演示（demo/*）。

3. 项目的配置文件介绍

package.json

package.json 是 Node.js 项目的核心配置文件，包含以下关键信息：

• name: 项目名称。
• version: 项目版本。
• scripts: 定义了项目中可用的脚本命令，例如 build、test 等。
• dependencies: 项目运行所需的依赖包。
• devDependencies: 开发过程中所需的依赖包。

tsconfig.json

tsconfig.json 是 TypeScript 项目的配置文件，定义了 TypeScript 编译器的选项，例如：

• compilerOptions: 包含编译选项，如 target、module、strict 等。
• include: 指定哪些文件需要被编译。
• exclude: 指定哪些文件不需要被编译。

.gitignore

.gitignore 文件用于指定哪些文件和目录不需要被 Git 跟踪，例如：

• node_modules/: 忽略 node_modules 目录。
• dist/: 忽略构建生成的 dist 目录。
• *.log: 忽略所有日志文件。

通过以上配置文件和启动脚本，开发者可以方便地管理和构建 ProseMirror 项目。