关于 hygiene
用于运行和了解 VS Code 仓库 git 提交前卫生检查的技能,帮助贡献者发现可能阻止提交的暂存文件问题。
主要功能
- 01运行提交前卫生检查
- 02扫描暂存文件中的问题
- 03无需暂存即可检查指定文件
- 04检测 Unicode 和引号风格违规
- 05检查版权头、格式和 lint
适用场景
- 01提交前检查暂存更改
- 02直接检查选定文件
- 03查找格式或 lint 错误
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ microsoft/ vscode --skill hygiene安装后在 Claude Code 中输入/hygiene确认已加载。
详细介绍
卫生检查
VS Code 会通过 Git 提交前钩子运行卫生检查。如果未通过,提交将被拒绝。
运行卫生检查
在声明工作完成之前,始终运行提交前卫生检查。 这可以发现会阻止提交的问题。
要对暂存的文件运行卫生检查:
npm run precommit
此命令会执行 node --experimental-strip-types build/hygiene.ts,仅扫描暂存文件(来自 git diff --cached)。
要直接检查特定文件(无需先暂存):
node --experimental-strip-types build/hygiene.ts path/to/file.ts
检查内容
卫生检查器会扫描暂存文件,查找以下问题(包括但不限于):
- Unicode 字符:不接受非 ASCII 字符(长破折号、弯引号、表情符号等)。在注释和代码中使用 ASCII 等效字符。可使用
// allow-any-unicode-next-line或// allow-any-unicode-comment-file禁用此检查。 - 双引号字符串:仅对外部化(本地化)字符串使用
"double quotes"。其他地方一律使用'single quotes'。 - 版权声明:所有文件都必须包含 Microsoft 版权声明。
- 缩进:只能使用制表符缩进,不得使用空格。
- 格式:TypeScript 文件必须符合格式化工具的输出(运行
Format Document进行修复)。 - ESLint:TypeScript 文件会使用 ESLint 进行检查。
- Stylelint:CSS 文件会使用 stylelint 进行检查。
评论
支持 Markdown