1-conventions — правило для Claude Code: что делает и как установить
Правило 1-conventions задаёт соглашения для TypeScript-файлов в src/ и tests/: структуру модулей, имена файлов и уровни тестов. Оно пригодится при добавлении кода и тестов в проект.
MIT ★ 571 обновлён 2026-10-29
.claude/rules/1-conventions.mdЧто делает 1-conventions
Правило применяется к src/**/*.ts и tests/**/*.ts. Оно требует именованные экспорты, запрещает barrel-файлы и реэкспорты, задаёт относительные импорты с расширением .js и предписывает использовать import type для типов. Для файлов нужны имена в kebab-case.ts, а типы тестов различаются по суффиксам .unit.test.ts, .integration.test.ts и .e2e.test.ts.
Для архитектурных тестов есть отдельное условие: файл *.arch.test.ts должен лежать в tests/architecture/, иначе он не запускается. Каталог tests/ должен повторять структуру src/. Дублирование проверяет pnpm jscpd; общий код предлагают выносить при появлении второго вызывающего места. Суффиксы файлов важны: проверки по ним не заметят файл с неправильным именем.
В Claude Code правило устанавливается файлом .claude/rules/1-conventions.md. Для Cursor и GitHub Copilot указаны отдельные пути. Правило охватывает TypeScript-файлы, поэтому соглашения из него не относятся к файлам с другими расширениями.
Какие задачи решает
- задать единый стиль экспортов и импортов в TypeScript-модулях
- назвать файлы и символы по соглашениям проекта
- разделить unit-, integration- и e2e-тесты по именам файлов
- найти дублирующийся код через
pnpm jscpd - проверить расположение архитектурных тестов
Примеры запросов агенту
- Добавь модуль в
src/и соблюдай правила экспортов и импортов. - Создай unit-тест для этого модуля с правильным суффиксом файла.
- Проверь, почему этот архитектурный тест не запускается.
Как установить 1-conventions
Вручную: положить файлы
.claude/rules/1-conventions.mdПоле paths во frontmatter ограничивает файлы
AGENTS.md
Codex читает AGENTS.md: вставьте текст правила туда
Вручную: положить файлы
.cursor/rules/1-conventions.mdcВо frontmatter: description, globs, alwaysApply
Вручную: положить файлы
.github/instructions/1-conventions.instructions.mdПоле applyTo задаёт, к каким файлам применять
Вручную: положить файлы
.devin/rules/1-conventions.mdВручную: положить файлы
.clinerules/1-conventions.mdПо шагам, с командами для каждой платформы: AGENTS.md и CLAUDE.md: что это, кто читает и какой выбрать
Вопросы о 1-conventions
Как установить 1-conventions в Claude Code?
Добавь в проект файл .claude/rules/1-conventions.md с содержимым правила.
Что делает 1-conventions?
Правило задаёт соглашения для TypeScript-файлов в src/ и tests/: экспорты, импорты, имена и расположение тестов.
Почему архитектурный тест может не запускаться?
Файл *.arch.test.ts вне tests/architecture/ не запускается. Проверь его расположение.
Исходный текст
1-conventions.md · MIT
---
description: Apply to every source and test file; module shape, naming and test tiers.
paths:
- "src/**/*.ts"
- "tests/**/*.ts"
---
# Conventions
## Modules
- Named exports only; biome's `noDefaultExport` holds it under `src/` and `tests/`.
- No barrel, no re-export: biome's `noBarrelFile`, `noReExportAll`, `noExportedImports`, plus `no-re-export.arch.test.ts` for `export { x } from` (`tests/helpers/ports/` exempt).
- Import from the defining module, relative, `.js` extension.
- `import type` for a type-only import.
## Names
- `kebab-case.ts` files; suffixes `-adapter.ts`, `-use-case.ts`.
- A port file is named for its interface: `file-merger.ts` for `FileMerger`.
- The ratchets read those suffixes; a misnamed file is invisible.
- `camelCase` values, `PascalCase` types, `CONSTANT_CASE` module constants.
- A leading underscore marks a parameter an interface forces.
- Name the intention: `applyFrameworkFile`, not `writeThenHash`.
- `executeInternal` means no concept was found; do not make it.
## Tests
- The extension declares the tier: `*.unit.test.ts`, `*.integration.test.ts`, `*.e2e.test.ts`.
- An `*.arch.test.ts` outside `tests/architecture/` runs nowhere.
- `tests/` mirrors `src/`.
## Duplication
- `pnpm jscpd` fails a copied block.
- Extract at the second caller (`0-shared-modules.md`).
© ai-driven-dev · MIT · ai-driven-dev/framework