@tker/check

项目代码质量检查工具包，提供循环依赖检测和代码格式检查功能。

安装

pnpm add -D @tker/check

使用方式

CLI 命令

安装后可通过 vsh 命令使用：

# 代码格式检查
vsh lint              # 检查代码格式问题
vsh lint --format     # 自动修复代码格式问题

# 循环依赖检测
vsh check-circular              # 检测整个项目的循环依赖
vsh check-circular --staged     # 只检查 Git 暂存区文件
vsh check-circular --verbose    # 显示详细信息
vsh check-circular --threshold <number>  # 设置循环依赖阈值，超过时退出码为 1
vsh check-circular --ignore-dirs <dirs>  # 忽略指定目录

作为依赖使用

import { defineCheckCircularCommand } from '@tker/check'
import { cac } from 'cac'

const cli = cac('my-cli')

// 注册循环依赖检测命令
defineCheckCircularCommand(cli)

cli.parse()

命令说明

lint

执行项目代码格式检查，支持以下工具：

• ESLint - JavaScript/TypeScript 代码规范检查
• Stylelint - CSS/SCSS 样式检查
• Prettier - 代码格式化检查

| 选项 | 说明 | |------|------| | --format | 自动修复代码格式问题 |

check-circular

检测项目中的循环依赖，帮助发现潜在的代码架构问题。

| 选项 | 说明 | |------|------| | --staged | 只检查 Git 暂存区的文件 | | --verbose | 显示详细的检测信息 | | --threshold <number> | 循环依赖阈值，超过时进程退出码为 1 | | --ignore-dirs <dirs> | 忽略检测的目录，逗号分隔 |

API

defineCheckCircularCommand(cli)

注册循环依赖检测命令到 CLI 实例。

import { defineCheckCircularCommand } from '@tker/check'
import { cac } from 'cac'

const cli = cac('my-cli')
defineCheckCircularCommand(cli)

CheckCircularConfig

循环依赖检测配置类型：

interface CheckCircularConfig {
  staged?: boolean      // 是否只检查暂存区
  verbose?: boolean     // 是否显示详细信息
  threshold?: number    // 循环依赖阈值
  ignoreDirs?: string   // 忽略的目录
}

License

MIT