You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
|
|
|
# RuoYi-Vue 编码规范
|
|
|
|
|
|
|
|
|
|
|
|
## 文档清单
|
|
|
|
|
|
|
|
|
|
|
|
1. [Java 编码规范](java-coding-standards.md)
|
|
|
|
|
|
2. [前端编码规范](frontend-coding-standards.md)
|
|
|
|
|
|
3. [Git 提交规范](git-commit-standards.md)
|
|
|
|
|
|
4. [Code Review 检查清单](code-review-checklist.md)
|
|
|
|
|
|
|
|
|
|
|
|
## 快速开始
|
|
|
|
|
|
|
|
|
|
|
|
### 前端开发
|
|
|
|
|
|
```bash
|
|
|
|
|
|
cd ruoyi-ui-next
|
|
|
|
|
|
npm install
|
|
|
|
|
|
npm run lint # 检查代码规范
|
|
|
|
|
|
npm run format # 格式化代码
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### 后端开发
|
|
|
|
|
|
```bash
|
|
|
|
|
|
# 使用 IDE 插件
|
|
|
|
|
|
# - IntelliJ: Checkstyle-IDEA 插件
|
|
|
|
|
|
# - VS Code: Checkstyle for Java 插件
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## 工具配置
|
|
|
|
|
|
|
|
|
|
|
|
- 前端:ESLint + Prettier + Husky
|
|
|
|
|
|
- 后端:Checkstyle + SpotBugs
|
|
|
|
|
|
- Git:Commitlint + Husky
|