Skip to content

Commit

Permalink
docs(projects): update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
honghuangdc committed Jun 11, 2023
1 parent 3417279 commit 47929ee
Showing 1 changed file with 35 additions and 34 deletions.
69 changes: 35 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,37 +20,38 @@ pnpm soy -h

## 命令介绍

| 命令 | 作用 |
| ----------------- | ------------------------------------------------------------------ |
| help | 查看全部命令用法 |
| git-commit | 生成符合 Angular 规范的 git 提交信息 |
| git-commit-verify | 校验 git 的提交信息是否符合 Angular 规范 |
| cleanup | 清空依赖和构建产物 |
| init-git-hooks | 初始化 simple-git-hooks 钩子 |
| update-pkg | 升级依赖 |
| prettier-format | prettier 格式化 |
| lint-staged | 执行 lint-staged |
| changelog | 根据两次 tag 生成 changelog (--total: 根据所有 tag 生成 changelog) |
| release | 发布:更新版本号、生成 changelog、提交代码 |

### prettier-format

底层调用 prettier --write 达到格式化文件的目的

默认忽略的格式化文件夹货文件:

- js,jsx,mjs,cjs,json,ts,tsx,mts,cts,vue,svelte,astro (通过 eslint 去格式化)
- node_modules
- _.min._
- CHANGELOG.md
- dist
- LICENSE\*
- output
- coverage
- public
- temp
- package-lock.json
- pnpm-lock.yaml
- yarn.lock
- .github
- **snapshots**
| 命令 | 作用 |
| --------------------- | ------------------------------------------------------------------ |
| help(-h) | 查看全部命令用法 |
| git-commit | 生成符合 Angular 规范的 git 提交信息 |
| git-commit-verify | 校验 git 的提交信息是否符合 Angular 规范 |
| cleanup | 清空依赖和构建产物 |
| init-simple-git-hooks | 初始化 simple-git-hooks 钩子 |
| ncu | 命令 npm-check-updates, 升级依赖 |
| prettier-write | 执行 prettier --write 格式化 |
| lint-staged | 执行 lint-staged |
| changelog | 根据两次 tag 生成 changelog (--total: 根据所有 tag 生成 changelog) |
| release | 发布:更新版本号、生成 changelog、提交代码 |
| init-git-hooks | 该命令已废弃,请使用 init-simple-git-hooks |
| update-pkg | 该命令已废弃,请使用 ncu |
| prettier-format | 该命令已废弃,请使用 prettier-write |
| eslint-prettier | 该命令已废弃 |

## 更多自定义配置

- 在项目根目录新建 soybean-config.ts

- 导入 defineConfig 函数

```ts
import { defineConfig } from "@soybeanjs/cli";

export default defineConfig({
//options
});
```

- 配置参考
```ts
import type { CliOption } from "@soybeanjs/cli";
```

0 comments on commit 47929ee

Please sign in to comment.