用途:为 OneKey 项目提供代码质量规范,适用于修复 lint 警告、运行 pre-commit 任务、处理未使用变量、编写注释以及确保代码质量等场景。
主要能力与用法:提供 lint 与类型检查命令。pre-commit 阶段使用 yarn lint:staged 与 yarn tsc:staged(仅检查暂存文件,速度快);CI 专用命令包括 yarn lint(综合检查 TypeScript、ESLint、目录结构、i18n)、yarn lint:only(仅 oxlint 快速检查)、yarn tsc:only(完整类型检查)。注意 yarn lint 仅用于 CI,pre-commit 应始终使用 yarn lint:staged。
常见 lint 修复:未使用变量或参数可加下划线前缀(如 unused: _unused、_unused);浮动 Promise 需加 void 或 await。
语言要求:所有注释必须使用英文,包括 JSDoc。注释应解释非显而易见的逻辑或业务逻辑,避免为显而易见的代码加注释。
开发原则:函数应遵循单一职责;避免过度抽象,不要为一次性操作创建辅助函数;保持一致的命名约定。
拼写检查:若技术术语触发拼写错误,可用 grep -i "yourword" development/spellCheckerSkipWords.txt 检查,若不存在则先询问团队负责人再执行 echo "yourword" >> development/spellCheckerSkipWords.txt。
检查清单:pre-commit 需通过 yarn lint:staged 与 yarn tsc:staged;代码质量需确保注释为英文、不提交注释掉的代码、函数单一职责、无多余抽象、命名一致。
相关技能:/1k-sentry-analysis、/1k-test-version、/1k-coding-patterns。
限制:资料未提供该技能的安装方式、收费信息、支持平台及具体效果数据。