file-headers — правило для Claude Code: шапка в каждом файле
Правило file-headers требует, чтобы каждый исходник начинался с комментария-шапки: короткое описание файла и строка @author Son Nguyen <[email protected]>.
MIT ★ 1 198 обновлён 2026-10-23
.claude/rules/file-headers.mdЧто делает file-headers
Правило задаёт шапку для файлов .js, .ts, .tsx, .cjs, .mjs, .py, .sh и .css. В начале файла — честное описание того, что в нём происходит, и точная строка @author Son Nguyen <[email protected]>. Вне правила остаются node_modules/, dist/, data/, .worktrees/, минифицированный и вендорный код, сгенерированный wiki/i18n-content.js и снапшоты.
Это обязательство для агента, а не для человека. Создаёшь файл — шапка пишется до кода, в скриптах после shebang. При правке файла без шапки она добавляется тем же изменением. Если правка меняет назначение файла, описание переписывается заодно.
Проверка автоматическая: bash .claude/skills/file-headers/scripts/check-headers.sh должен завершиться с кодом 0. Скрипт и форматы шапок лежат в .claude/skills/file-headers/, поэтому без этого скилла в проекте правило держится на честном слове. Установка — один файл .claude/rules/file-headers.md.
Какие задачи решает
- дописать шапку в новый файл до первого коммита
- вернуть шапку туда, откуда её вычистил рефакторинг
- переписать описание файла, когда меняется его назначение
- сверить авторские строки во всём репозитории за один прогон
- уронить сборку, если исходник уехал без шапки
Примеры запросов агенту
- Создай
src/metrics.tsи сразу поставь сверху шапку с@author Son Nguyen <[email protected]>. - В
scripts/deploy.shнет шапки — добавь её после shebang, логику не трогай. - Прогони
bash .claude/skills/file-headers/scripts/check-headers.shи почини все файлы, на которые он ругается.
Как установить file-headers
Вручную: положить файлы
.claude/rules/file-headers.mdПоле paths во frontmatter ограничивает файлы
AGENTS.md
Codex читает AGENTS.md: вставьте текст правила туда
Вручную: положить файлы
.cursor/rules/file-headers.mdcВо frontmatter: description, globs, alwaysApply
Вручную: положить файлы
.github/instructions/file-headers.instructions.mdПоле applyTo задаёт, к каким файлам применять
Вручную: положить файлы
.devin/rules/file-headers.mdВручную: положить файлы
.clinerules/file-headers.mdПо шагам, с командами для каждой платформы: AGENTS.md и CLAUDE.md: что это, кто читает и какой выбрать
Вопросы о file-headers
Как установить file-headers в Claude Code?
Положить файл правила по пути .claude/rules/file-headers.md. Claude читает правила из этой папки.
Что делает file-headers?
Заставляет каждый подходящий исходник начинаться с краткого описания и точной строки @author Son Nguyen <[email protected]>. Шапка добавляется и при правке файла, где её не было.
Чем проверить, что весь репозиторий соответствует правилу?
Запустить bash .claude/skills/file-headers/scripts/check-headers.sh: он должен выйти с кодом 0. Сам скрипт и форматы шапок хранятся в .claude/skills/file-headers/.
Исходный текст
file-headers.md · MIT
# File Header Rules (binding for every coding agent) - Every applicable source file (`.js/.ts/.tsx/.cjs/.mjs/.py/.sh/.css` — excluding `node_modules/`, `dist/`, `data/`, `.worktrees/`, minified/vendored, generated `wiki/i18n-content.js`, snapshots) MUST start with the header comment: a truthful file overview plus the exact line `@author Son Nguyen <[email protected]>`. - Creating a new applicable file → write the header before any code (after the shebang in scripts). - Editing a file that lacks the header → add it in the same change; if the edit changes the file's purpose, update the overview. - Formats and the repo-wide audit script live in `.claude/skills/file-headers/` (`bash .claude/skills/file-headers/scripts/check-headers.sh` must exit 0).
© hoangsonww · MIT · hoangsonww/Claude-Code-Agent-Monitor