@bud-fe/cli-xima
v0.3.1
Published
百威前端代码规约配置脚本
Downloads
33
Keywords
Readme
@bud-fe/cli-xima
百威前端代码规约配置脚本。
- 一键配置 ESLint、stylelint、commitlint、prettier、husky、lint-staged
- 所有规约配置基于 @iceworks/spec
- 脚本代码参考自 F2ELint,在此基础上加入了针对
pnpm
的依赖提升逻辑 - 代码规约请参考 https://github.com/alibaba/f2e-spec
目前支持的项目类型:
- React
- Taro React
- Vue
使用
在项目根目录直接执行:
$ npx @bud-fe/cli-xima init
具体细节
init
命令主要做了几件事:
- 安装
@bud-fe/cli-xima
到项目的devDependencies
- 配置 ESLint、stylelint、commitlint、prettier、husky、lint-staged(会先删除项目中原有的配置文件、依赖)
- 配置 .vscode(会先删除项目中原有文件)。建议安装好 vscode 相关插件(ESLint、stylelint、prettier 三件套,这样就可以在 vscode 编辑器中实时的查看到 lint 结果)
- 添加一些 npm script,方便开发者对全量代码进行扫描&修复
- 由于通用的代码规约的依赖都会收口安装在 @bud-fe/cli-xima,所以如果是
pnpm
项目,会把对应的依赖做提升(修改 .npmrc)。但是一些特定项目类型的依赖还是会单独安装在项目中