State Machine Cat 项目使用与配置指南

1. 项目目录结构及介绍

State Machine Cat 是一个用于生成美丽状态图的工具，其项目目录结构如下：

state-machine-cat/
├── dist/                   # 存放编译后的文件
├── docs/                   # 文档目录
│   ├── api.md              # API 文档
│   ├── grammar.html        # 语法图
│   └── index.html          # 项目主页
├── src/                    # 源代码目录
│   ├── parse/              # 解析器相关代码
│   ├── render/             # 渲染器相关代码
│   └── utils/              # 工具函数
├── test/                   # 测试目录
├── .circleci/              # CircleCI 配置文件
├── .eslintrc.js            # ESLint 配置文件
├── .gitattributes           # Git 属性配置文件
├── .gitignore              # Git 忽略文件
├── .prettierrc             # Prettier 配置文件
└── package.json            # 项目依赖和配置

• dist/ 目录包含编译后的 JavaScript 文件，用于在生产环境中使用。
• docs/ 目录包含项目的文档，包括 API 文档和语法图。
• src/ 目录包含项目的源代码，包括解析器和渲染器。
• test/ 目录包含项目的单元测试。
• .circleci/ 目录包含 CI/CD 配置文件。
• .eslintrc.js、.prettierrc 等文件是代码风格和格式化配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js，它是 State Machine Cat 的入口点。该文件负责初始化解析器和渲染器，并提供了命令行接口。

以下是 src/index.js 的主要功能：

• 解析命令行参数。
• 读取和解析状态机定义文件。
• 根据定义生成状态图。
• 输出状态图到指定的格式（如 SVG、DOT 等）。

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json，它定义了项目的依赖、脚本和元数据。

以下是 package.json 的关键部分：

• dependencies：项目的依赖列表。
• scripts：项目的脚本，包括启动开发服务器、构建生产版本等。
• devDependencies：开发依赖，仅在开发过程中使用。
• peerDependencies：项目需要的同伴依赖，通常由用户安装。
• browserslist：项目支持的浏览器列表。

例如，以下是一个简化的 package.json 配置：

{
  "name": "state-machine-cat",
  "version": "1.0.0",
  "description": "Write beautiful state charts",
  "main": "dist/state-machine-cat.js",
  "scripts": {
    "start": "node src/index.js",
    "build": "rollup -c"
  },
  "dependencies": {
    "some-dependency": "^1.0.0"
  },
  "devDependencies": {
    " Rollup": "^2.0.0"
  },
  "browserslist": [
    "last 2 versions",
    "not dead"
  ]
}

这个配置文件定义了项目的名称、版本、描述、入口文件、脚本、依赖和浏览器兼容性。通过运行 npm start 可以启动项目，而 npm run build 用于构建项目。