Dimon94

file-header-guardian

@Dimon94/file-header-guardian
Dimon94
95
25 forks
Updated 1/6/2026
View on GitHub

文件头三行契约注释。触发:create file、新建文件、编写代码。

Installation

$skills install @Dimon94/file-header-guardian
Claude Code
Cursor
Copilot
Codex
Antigravity

Details

Path.claude/skills/file-header-guardian/SKILL.md
Branchmain
Scoped Name@Dimon94/file-header-guardian

Usage

After installing, this skill will be available to your AI coding assistant.

Verify installation:

skills list

Skill Instructions


name: file-header-guardian description: 文件头三行契约注释。触发:create file、新建文件、编写代码。

文件头注释守护者

触发:创建代码文件,修改文件后检查头注释准确性。

模板

TS/JS:

/**
 * @input  依赖什么
 * @output 提供什么
 * @pos    系统地位
 * ⚠️ 修改后同步:文件头 + 目录 CLAUDE.md
 */

Python:

"""
@input  依赖什么
@output 提供什么
@pos    系统地位
⚠️ 修改后同步:文件头 + 目录 CLAUDE.md
"""

Shell:

# @input  依赖什么
# @output 提供什么
# @pos    系统地位
# ⚠️ 修改后同步:文件头 + 目录 CLAUDE.md

示例

/**
 * @input  prisma.service 数据库连接
 * @output UserService: create/update/delete
 * @pos    用户模块核心
 * ⚠️ 修改后同步:文件头 + 目录 CLAUDE.md
 */
export class UserService { }

豁免

配置文件(json/yaml)、样式(css)、生成文件(*.d.ts)、node_modules。

协作:本 skill 管文件,fractal-docs-generator 管目录。