Ruler 项目使用教程

1. 项目目录结构及介绍

Ruler 项目的目录结构如下：

ruler/
├── config/
│   ├── config.demo.js
│   └── ...
├── demo/
│   ├── index.html
│   └── ...
├── packages/
│   ├── ruler/
│   │   ├── src/
│   │   └── ...
│   └── ...
├── static/
│   └── scripts/
│       └── ...
├── .editorconfig
├── .gitignore
├── .npmignore
├── .yarnrc
├── CHANGELOG.md
├── LICENSE
├── README.md
├── jsdoc.json
├── lerna.json
├── package.json
├── rollup.config.demo.js
├── tslint.json
└── yarn.lock

目录结构介绍

• config/: 包含项目的配置文件，如 config.demo.js。
• demo/: 包含项目的演示文件，如 index.html。
• packages/: 包含项目的各个子包，如 ruler 包。
• static/scripts/: 包含静态脚本文件。
• .editorconfig: 编辑器配置文件。
• .gitignore: Git 忽略文件配置。
• .npmignore: npm 发布时忽略的文件配置。
• .yarnrc: Yarn 配置文件。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• jsdoc.json: JSDoc 配置文件。
• lerna.json: Lerna 配置文件。
• package.json: 项目依赖和脚本配置。
• rollup.config.demo.js: Rollup 打包配置文件。
• tslint.json: TSLint 配置文件。
• yarn.lock: Yarn 锁定文件。

2. 项目启动文件介绍

Ruler 项目的启动文件主要位于 demo/ 目录下，其中 index.html 是主要的演示页面。启动项目时，可以通过以下步骤进行：

1. 安装依赖: 使用 npm install 或 yarn install 安装项目依赖。
2. 启动演示: 运行 npm run demo 或 yarn demo 启动演示页面。

启动文件介绍

• demo/index.html: 这是项目的演示页面，包含了 Ruler 组件的使用示例。

3. 项目的配置文件介绍

Ruler 项目的配置文件主要位于 config/ 和根目录下。以下是主要的配置文件介绍：

配置文件介绍

• config/config.demo.js: 演示页面的配置文件，包含了 Ruler 组件的初始化配置。
• package.json: 项目的主配置文件，包含了项目的依赖、脚本命令等信息。
• rollup.config.demo.js: Rollup 打包配置文件，用于打包演示页面。
• tslint.json: TSLint 配置文件，用于代码风格检查。
• jsdoc.json: JSDoc 配置文件，用于生成 API 文档。
• lerna.json: Lerna 配置文件，用于管理多包项目。

通过以上配置文件，可以对 Ruler 项目进行定制和扩展。