woodpecker

详细说明请看 wikihttps://wiki.n.miui.com/pages/viewpage.action?pageId=194334369

Eslint、Prettier、Commitlint、Editorconfig、Gitignore 自动注入工具

• Prettier
• Eslint(多种 config 可选)
• Husky
• Lint-staged
• Commitlint (angular style 开源项目主流 commit 规范)
• Editorconfig
• Gitignore

安装

npm i -g @lxfriday/woodpecker

使用

woodpecker i

选择注入选项

点击 a 自动选中全部功能， 点空格选择或者取消选择单个功能。选好之后回车自动开始安装

$ woodpecker i
woodpecker v2.0.2

-> 开始执行

? 需要注入什么功能？ (Press <space> to select, <a> to toggle all, <i> to invert selection)
>( ) Prettier: 格式化代码
 ( ) Commitlint: 限制 commit message 格式
 ( ) Eslint: 注入 Eslint 功能，选中之后下一步可选择 Eslint config 类型
 ( ) Editorconfig: 添加 .editorconfig 到根目录
 ( ) Gitignore: 添加 .gitignore 到根目录

Eslint 可选项

? 安装下列哪个 Eslint config？ (Use arrow keys)
> airbnb
  eslint-config-react-app

woodpecker f

自动配置 vscode

将会对用户的 settings.json 配置文件进行更改，如下，需要预先安装 Prettier 插件

  "editor.formatOnSave": true, // 保存时 format
  "editor.formatOnPaste": true, // 粘贴时 format
  "editor.defaultFormatter": "esbenp.prettier-vscode" // 设置默认的 formatter 为 prettier

注意

当 Prettier 和 Eslint 同时存在时，Eslint 规则会受到 Prettier 影响，Prettier 自动格式化时变更为 Pretiter 配置文件对应的格式

相关链接

• Prettier
• Prettier 配置项
• Eslint rules(中文)
• Husky
• Lint-staged
• Commitlint
• angular commit message: @commitlint/config-angular
• 阮一峰 Commit message 和 Change log 编写指南