feat(preset-umi): add precommit generator #9784
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Ignored Deployment
|
Codecov ReportBase: 28.44% // Head: 28.37% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #9784 +/- ##
==========================================
- Coverage 28.44% 28.37% -0.08%
==========================================
Files 428 429 +1
Lines 12073 12103 +30
Branches 2884 2890 +6
==========================================
Hits 3434 3434
- Misses 8082 8108 +26
- Partials 557 561 +4
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
|
|
||
| // 添加 .lintstagedrc | ||
| writeFileSync( | ||
| join(api.cwd, '.lintstagedrc'), |
| "prettier --cache --write" | ||
| ], | ||
| "*.ts?(x)": [ | ||
| "umi lint --fix --eslint-only", |
| } | ||
|
|
||
| writeFileSync( | ||
| join(api.cwd, '.husky/commit-msg'), |
There was a problem hiding this comment.
需要验证一下写出来的文件有没有执行权限，或者这里给他赋予一下，在 macos / linux ，人为写出来的 shell 文件可能没有执行权限。
docs/docs/guides/generator.md
Outdated
|
|
||
| ```bash | ||
| $umi g precommit | ||
| info - @local |
docs/docs/guides/generator.md
Outdated
|
|
||
| ### Precommit 配置生成器 | ||
|
|
||
| 为项目生成 [precommit](https://typicode.github.io/husky) 配置，命令执行后，`umi` 会生成推荐的 precommit 配置和安装相应的依赖。 |
There was a problem hiding this comment.
描述个人认为太简单了，可以再详细一点描下做了什么事，主要是：
-
添加 husky 和 Git commit message 格式校验行为
-
在每次 Git commit 前会将 Git 暂存区的代码默认格式化
注：如果是初始化出来的 max 项目，通常不需要该生成器，因为已经配置好 husky 了
did-you-know/package.json
Outdated
| @@ -90,6 +90,11 @@ | |||
| "url": "https://umijs.org/docs/guides/generator#prettier-%E9%85%8D%E7%BD%AE%E7%94%9F%E6%88%90%E5%99%A8", | |||
| "majorVersion": 4 | |||
| }, | |||
| { | |||
| "text": "如果你需要使用 Precommit, %%frameworkCliName%% g precommit 就可以一键完成配置", | |||
There was a problem hiding this comment.
个人认为描述再精确一点：
如果你要增加 Git 提交消息校验和自动代码格式化，可以......
会更好
添加微生成器-precommit
View rendered docs/docs/guides/generator.md