1.0.1 • Published 2 years ago
@xlt-group/create-project-eslint v1.0.1
初衷
旨在帮助我们在新项目中快速的创建 eslint+prettier+husky 配置文件,eslint 规则使用的是Alloy/eslint-config-alloy 规则
目标
一条命令完成 eslint+prettier+husky 配置文件
你将得到
- 保存代码自动格式化 💯
- 提交前 commit 校验 💯
- eslint + pretter 校验 💯
- husky 自动装载 💯
- 适用多个项目
安装
1 局部安装(推荐使用)
npm create @xlt-group/project-eslint@latest
使用
运行命令
在初始化过程中,如果项目中.git文件,会自动执行 git init 命令
mac 电脑执行 `npm run postinstallmac` 来设置 husky 的读写权限
验证
代码提交前校验
npm run commit
支持的模板
npm create @xlt-group/project-eslint@latest
? Select a Eslint+Prettier template? › - Use arrow-keys. Return to submit.
❯ Javascript
Typescript
Vue2
Vue3
React
React+Typescript
Vue2+Typescript
Vue3+Typescript
效果预览
npm create @xlt-group/project-eslint@latest
✔ Select a Eslint+Prettier template? › Typescript
✔ Is add .git and .husky? … yes
[web-eslint]:✅ package.json
[web-eslint]:✅ .eslintrc.js
[web-eslint]:✅ .eslintignore
[web-eslint]:✅ .editorconfig
[web-eslint]:✅ .prettierrc.js
[web-eslint]:✅ .prettierignore
[web-eslint]:✅ .cz-config.js
[web-eslint]:✅ commitlint.config.js
[web-eslint]:✅ .husky
已初始化空的 Git 仓库于 /Volumes/weipengcheng/sourceCode/test-demo/test-demo/eslint-demo/.git/
[web-eslint]:接下来执行npm install...请等待完成
> eslint-demo@1.0.0 prepare
> husky install
husky - Git hooks installed
added 410 packages in 19s
[web-eslint]:eslint+prettier+husky配置文件初始化成功!
[web-eslint]:
😎 如果你吃饭的家伙是vscode
😎 请自行配置.vscode 文件
😘 推荐安装vscode插件 eslint、prettier