maxGraph 项目教程

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

maxGraph 项目的目录结构如下：

maxGraph/
├── docs/
│   └── images/
├── packages/
├── .eslintignore
├── .eslintrc.json
├── .gitignore
├── .nvmrc
├── .prettierrc
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── LICENSE
├── NOTICE
├── README.md
├── SECURITY.md
├── package-lock.json
├── package.json
└── tsconfig.json

目录介绍

• docs/: 包含项目文档的图片资源。
• packages/: 包含项目的核心代码包。
• .eslintignore: ESLint 忽略配置文件。
• .eslintrc.json: ESLint 配置文件。
• .gitignore: Git 忽略配置文件。
• .nvmrc: Node 版本管理配置文件。
• .prettierrc: Prettier 代码格式化配置文件。
• CHANGELOG.md: 项目更新日志。
• CODE_OF_CONDUCT.md: 项目行为准则。
• LICENSE: 项目许可证。
• NOTICE: 项目通知文件。
• README.md: 项目自述文件。
• SECURITY.md: 项目安全政策。
• package-lock.json: npm 依赖锁定文件。
• package.json: npm 项目配置文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

maxGraph 项目的启动文件主要是 package.json 中的 "start" 脚本。

{
  "scripts": {
    "start": "npm run build && node server.js"
  }
}

启动流程

1. 执行 npm run build 构建项目。
2. 运行 node server.js 启动服务器。

3. 项目的配置文件介绍

package.json

package.json 是 npm 项目的配置文件，包含项目的基本信息、依赖、脚本等。

{
  "name": "maxgraph",
  "version": "1.0.0",
  "description": "A fully client-side JavaScript diagramming library",
  "main": "index.js",
  "scripts": {
    "start": "npm run build && node server.js",
    "build": "tsc"
  },
  "dependencies": {
    "typescript": "^4.0.0"
  },
  "devDependencies": {
    "eslint": "^7.0.0",
    "prettier": "^2.0.0"
  }
}

tsconfig.json

tsconfig.json 是 TypeScript 项目的配置文件，包含编译选项等。

{
  "compilerOptions": {
    "module": "commonjs",
    "target": "es5",
    "outDir": "./dist",
    "strict": true
  },
  "include": [
    "src/**/*"
  ]
}

.eslintrc.json

.eslintrc.json 是 ESLint 的配置文件，用于代码风格检查。

{
  "parser": "@typescript-eslint/parser",
  "plugins": [
    "@typescript-eslint"
  ],
  "extends": [
    "eslint:recommended",
    "plugin:@typescript-eslint/recommended"
  ]
}

.prettierrc

.prettierrc 是 Prettier 的配置文件，用于代码格式化。

{
  "singleQuote": true,
  "trailingComma": "all"
}

通过以上配置文件，可以对 maxGraph 项目进行构建、启动和代码风格检查。