Pospal

Appearance

开始 ​

总览 ​

当团队有了统一的代码质量评价标准后，便需要严格的执行代码编写规范。

对于规范的制约，我们提供了pospal-lint相关工具链

安装 ​

注意

  • pospal lint需要 Node.js 版本 >= 18.0.0
  • 只支持使用 pnpm8.x 版本进行安装
bash
# 安装lint工具
pnpm add @pospal/lint --D

# 如果是monorepo大仓项目
pnpm add @pospal/lint -Dw

命令 ​

执行 npx @pospal/lint -h即可查看全部命令:

bash
Commands:
  init # 初始化命令
  commit-lint [message] # commitlint校验
  lint-staged #  lint-staged校验

欲了解更多信息，请运行带有--help标志的任何命令：

bash
  pospal-lint init --help
  pospal-lint scan --help
  pospal-lint commit-lint --help
  pospal-lint lint-staged --help

init 初始化命令 ​

pospal-lint init --help

bash
Usage:
  $ pospal-lint 一键接入: 为项目初始化规范工具、配置、及相关依赖。

commit-lint 扫描命令 ​

pospal-lint commit-lint --help

bash
Usage:
  $ pospal-lint commit message 校验: git commit 时对 commit message 进行校验

Options:
  -E, --edit [path]  [string]检查环境变量值所给路径上的文件中的信息

lint-staged 扫描命令 ​

pospal-lint lint-staged --help

bash
Usage:
  $ pospal-lint lint-staged校验，对提交的文件进行格式化。使用Node.js-API方式调用

安装完成之后即可执行接入