erd-editor 开源项目使用教程

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

erd-editor 项目的目录结构如下：

erd-editor/
├── data/
├── docker/
├── img/
├── json-schema/
├── packages/
├── .editorconfig
├── .eslintrc.json
├── .gitignore
├── .nvmrc
├── .prettierrc.json
├── LICENSE
├── README.md
├── erd-editor.code-workspace
├── nx.json
├── package.json
├── pnpm-lock.yaml
├── pnpm-workspace.yaml
├── tsconfig.json

目录介绍

• data/: 存放项目数据文件。
• docker/: 存放 Docker 相关文件。
• img/: 存放项目图片资源。
• json-schema/: 存放 JSON 模式文件。
• packages/: 存放项目包文件。
• .editorconfig: 编辑器配置文件。
• .eslintrc.json: ESLint 配置文件。
• .gitignore: Git 忽略文件配置。
• .nvmrc: Node 版本管理配置文件。
• .prettierrc.json: Prettier 代码格式化配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• erd-editor.code-workspace: VSCode 工作区配置文件。
• nx.json: Nx 配置文件。
• package.json: 项目依赖和脚本配置文件。
• pnpm-lock.yaml: pnpm 锁定文件。
• pnpm-workspace.yaml: pnpm 工作区配置文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

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

{
  "scripts": {
    "start": "nx serve",
    "build": "nx build",
    "test": "nx test",
    "lint": "nx lint"
  }
}

启动脚本介绍

• start: 启动开发服务器。
• build: 构建项目。
• test: 运行测试。
• lint: 运行代码检查。

3. 项目的配置文件介绍

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

.editorconfig

用于统一不同编辑器和 IDE 的编码风格。

root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

.eslintrc.json

ESLint 配置文件，用于代码检查。

{
  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
  "parser": "@typescript-eslint/parser",
  "plugins": ["@typescript-eslint"],
  "rules": {
    // 自定义规则
  }
}

.prettierrc.json

Prettier 配置文件，用于代码格式化。

{
  "singleQuote": true,
  "trailingComma": "all",
  "printWidth": 80,
  "tabWidth": 2
}

tsconfig.json

TypeScript 配置文件，用于编译 TypeScript 代码。

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src"]
}

以上是 erd-editor 开源项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！