0.2.4 • Published 3 years ago

teamix-standard v0.2.4

Weekly downloads
21
License
MIT
Repository
-
Last release
3 years ago

teamix-standard

teamix-standard 是 teamix 工程标准化配套工具,功能包括安装各种lint(ESlint、stylelint、Commitlint)和配置(如.editorconfig、Prettier)、配置 git commit 卡点、代码规约问题扫描、代码规约问题自动修复、生成质量报告等

使用

安装

在工程根目录执行:

npx teamix-standard init

按提示进行操作,整个初始化过程分 4 步:

  1. 选择需要的工具或配置,建议全选直接回车即可:

    npm.io

    若有选择 ESLint,需进一步选择 ESLint 项目类型:

    npm.io

  2. 安装依赖

  3. 写入配置文件
  4. 配置commit卡点

git commit 卡点

安装完成后,git commit 时 teamix-standard 会对增量代码和 commit message 进行规约检查。

ESLint 卡点:

npm.io

stylelint 卡点:

npm.io

commitlint 卡点:

npm.io

commit message 规范

执行扫描

在仓库根目录执行 npm run standard-scan,可以对仓库进行一次代码规约扫描,执行 ESLint、stylelint 等的 lint 工具:

npm.io

自动修复扫描问题

在仓库根目录执行 npm run standard-fix,可以对仓库进行一次扫描问题自动修复,执行 ESLint、stylelint 等的 lint 工具的 --fix 功能:

npm.io

其他

执行 npx teamix-standard -h,查看详细使用帮助:

Usage: cli [options] [command]


teamix-standard 是 teamix 工程标准化配套工具,功能包括安装各种lint(ESlint、stylelint、Commitlint)和配置(如.editorconfig、Prettier)、配置 git commit 卡点、代码规约问题扫描、代码规约问题自动修复、生成质量报告等


Options:
  -V, --version  output the version number
  -h, --help     output usage information

Commands:
  init           初始化标准化相关配置,您可以选择需要的工具
  update         更新 teamix-standard 至最新版本
  scan           对仓库进行代码规约扫描
  fix            自动修复仓库代码规约扫描问题
  exec <linter>  执行 eslint / stylelint / commitlint 等 teamix-standard 依赖包命令