用途
Coding Standards Enforcer 用于自动化代码质量与一致性检查,通过 linter、格式化工具和提交钩子,让代码库在风格和规范上保持统一。它适合需要在多人协作或长期维护的项目中,减少因风格差异带来的噪音,并在代码进入仓库前自动完成检查与修复。
主要能力
该技能围绕三类工具展开:
-
ESLint 配置:提供
.eslintrc.js示例,继承eslint:recommended、plugin:@typescript-eslint/recommended、plugin:react/recommended和prettier,并设置若干规则,例如no-console为警告、@typescript-eslint/no-unused-vars为错误、@typescript-eslint/explicit-function-return-type为警告、关闭react/prop-types,以及complexity和max-lines-per-function的阈值警告。 -
Prettier 配置:提供 JSON 配置示例,包含
semi、singleQuote、trailingComma、printWidth、tabWidth、arrowParens等选项。 -
Pre-commit 钩子:通过
package.json中的husky与lint-staged配置,在提交前对*.{ts,tsx}执行eslint --fix和prettier --write,对*.{json,md}执行prettier --write。
此外,技能还给出了命名约定示例:类与类型使用 PascalCase,函数与变量使用 camelCase,常量使用 UPPER_SNAKE_CASE,文件名使用 kebab-case。
使用方式
资料中提供了 Git 钩子的安装与初始化命令:
# Install husky
npm install --save-dev husky lint-staged
# Initialize husky
npx husky install
# Add pre-commit hook
npx husky add .husky/pre-commit "npx lint-staged"
配置层面,将 ESLint 配置写入 .eslintrc.js,将 Prettier 配置写入对应配置文件,并在 package.json 中声明 husky 与 lint-staged 字段。提交代码时,钩子会自动对暂存文件执行 lint 修复与格式化。
适用场景
- 需要统一代码风格的前端或 TypeScript 项目。
- 使用 React 并希望集成 ESLint 与 Prettier 的团队。
- 希望在提交前自动修复格式问题、减少代码审查中风格争议的仓库。
- 需要为类、类型、函数、变量、常量和文件命名建立明确约定的项目。
限制
资料中未提供该技能的具体安装方式、运行命令、支持的语言范围、平台兼容性、收费模式或性能数据。上述配置示例以 JavaScript/TypeScript 与 React 为主,其他语言或框架的适配情况暂未提供。集成点中提到的 verification-loop、tdd-workflow、code-refactoring-patterns 仅作为互补技能列出,其具体用法与依赖关系暂未提供。