clean-code · pproenca — скилл для Claude Code: правила чистого кода
Скилл для ревью и рефакторинга: 48 правил из книги Роберта Мартина с современными поправками. Пригодится, когда агент пишет или разбирает код.
npx skills add pproenca/dot-skills --skill clean-code -a claude-codeЧто делает clean-code
Скилл разбит на 10 категорий с приоритетами: имена, функции, комментарии, форматирование, обработка ошибок, объекты, границы, классы, тесты и простота дизайна. У каждого правила свой префикс — name-, func-, cmt- и так далее — и отдельный файл с объяснением и примерами. Примеры в основном на Java, но принципы не привязаны к языку.
Внутри лежит таблица приоритетов: имена и функции помечены как CRITICAL, комментарии, форматирование и ошибки — HIGH, остальное ниже. Агент подтягивает нужное правило, когда вы просите назвать переменную, разбить функцию или написать тест. Есть шаблон для добавления своих правил.
Скилл опирается на издание 2008 года, поэтому часть советов переписана под современную практику. Если в проекте свой гайдлайн по стилю, правила форматирования из скилла могут с ним разойтись — это повод проверить, что победит в вашем ревью.
Какие задачи решает
- переименовать переменные так, чтобы имя объясняло смысл
- разбить длинную функцию на части с одним уровнем абстракции
- убрать закомментированный код и лишние комментарии
- обернуть стороннюю библиотеку и написать к ней learning tests
- переписать тест, который проверяет сразу несколько вещей
Примеры запросов агенту
- проверь этот модуль по правилам clean-code и покажи, что нарушено
- предложи имена для этих переменных по name-intention-revealing
- разбей функцию
processOrderпо func-one-thing и func-small
Как установить clean-code
1Через Skills CLI (Vercel)
npx skills add pproenca/dot-skills --skill clean-code -a claude-code2Вручную: положить файлы
~/.claude/skills/clean-code/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/clean-code/
1Через Skills CLI (Vercel)
npx skills add pproenca/dot-skills --skill clean-code -a codex2Вручную: положить файлы
.agents/skills/clean-code/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add pproenca/dot-skills --skill clean-code -a cursor2Вручную: положить файлы
.cursor/skills/clean-code/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install pproenca/dot-skills clean-code2Вручную: положить файлы
.github/skills/clean-code/SKILL.md1Через Skills CLI (Vercel)
npx skills add pproenca/dot-skills --skill clean-code -a gemini-cli2Командой платформы
gemini skills install https://github.com/pproenca/dot-skills --path skills/.experimental/clean-codeВручную: положить файлы
.devin/skills/clean-code/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Через Skills CLI (Vercel)
npx skills add pproenca/dot-skills --skill clean-code -a opencodeClaude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов
Вопросы о clean-code
Как установить clean-code в Claude?
Выполните npx skills add pproenca/dot-skills --skill clean-code -a claude-code. После этого скилл окажется в ~/.claude/skills/clean-code/SKILL.md.
Что делает скилл clean-code?
Даёт агенту 48 правил по именам, функциям, комментариям, ошибкам, классам и тестам. Он применяет их при написании кода, ревью и рефакторинге.
Чем этот скилл отличается от книги Clean Code?
Он собран по книге Роберта Мартина, но советы 2008 года, которые устарели, переписаны. Правила разложены по 10 категориям и отсортированы по влиянию на код.
Исходный текст
SKILL.md · MIT
--- name: clean-code description: Use when writing, reviewing, or refactoring code for maintainability and readability. Triggers on code reviews, naming discussions, function design, error handling, and test writing. Based on Robert C. Martin's Clean Code handbook with modern corrections. --- # Robert C. Martin (Uncle Bob) Clean Code Best Practices Comprehensive software craftsmanship guide based on Robert C. Martin's "Clean Code: A Handbook of Agile Software Craftsmanship", updated with modern corrections where the original 2008 advice has been superseded. Contains 48 rules across 10 categories, prioritized by impact to guide code reviews, refactoring decisions, and new development. Examples are primarily in Java but principles are language-agnostic. ## When to Apply Reference these guidelines when: - Writing new functions, classes, or modules - Naming variables, functions, classes, or files - Reviewing code for maintainability issues - Refactoring existing code to improve clarity - Writing or improving unit tests - Wrapping third-party dependencies ## Rule Categories by Priority | Priority | Category | Impact | Prefix | |----------|----------|--------|--------| | 1 | Meaningful Names | CRITICAL | `name-` | | 2 | Functions | CRITICAL | `func-` | | 3 | Comments | HIGH | `cmt-` | | 4 | Formatting | HIGH | `fmt-` | | 5 | Error Handling | HIGH | `err-` | | 6 | Objects and Data Structures | MEDIUM-HIGH | `obj-` | | 7 | Boundaries | MEDIUM-HIGH | `bound-` | | 8 | Classes and Systems | MEDIUM-HIGH | `class-` | | 9 | Unit Tests | MEDIUM | `test-` | | 10 | Emergence and Simple Design | MEDIUM | `emerge-` | ## Quick Reference ### 1. Meaningful Names (CRITICAL) - [`name-intention-revealing`](references/name-intention-revealing.md) - Use names that reveal intent - [`name-avoid-disinformation`](references/name-avoid-disinformation.md) - Avoid misleading names - [`name-meaningful-distinctions`](references/name-meaningful-distinctions.md) - Make meaningful distinctions - [`name-pronounceable`](references/name-pronounceable.md) - Use pronounceable names - [`name-searchable`](references/name-searchable.md) - Use searchable names - [`name-avoid-encodings`](references/name-avoid-encodings.md) - Avoid encodings in names - [`name-class-noun`](references/name-class-noun.md) - Use noun phrases for class names - [`name-method-verb`](references/name-method-verb.md) - Use verb phrases for method names ### 2. Functions (CRITICAL) - [`func-small`](references/func-small.md) - Keep functions small - [`func-one-thing`](references/func-one-thing.md) - Functions should do one thing - [`func-abstraction-level`](references/func-abstraction-level.md) - Maintain one level of abstraction - [`func-minimize-arguments`](references/func-minimize-arguments.md) - Minimize function arguments - [`func-no-side-effects`](references/func-no-side-effects.md) - Avoid side effects - [`func-command-query-separation`](references/func-command-query-separation.md) - Separate commands from queries - [`func-dry`](references/func-dry.md) - Do not repeat yourself ### 3. Comments (HIGH) - [`cmt-express-in-code`](references/cmt-express-in-code.md) - Express yourself in code, not comments - [`cmt-explain-intent`](references/cmt-explain-intent.md) - Use comments to explain intent - [`cmt-avoid-redundant`](references/cmt-avoid-redundant.md) - Avoid redundant comments - [`cmt-avoid-commented-out-code`](references/cmt-avoid-commented-out-code.md) - Delete commented-out code - [`cmt-warning-consequences`](references/cmt-warning-consequences.md) - Use warning comments for consequences ### 4. Formatting (HIGH) - [`fmt-vertical-formatting`](references/fmt-vertical-formatting.md) - Use vertical formatting for readability - [`fmt-horizontal-alignment`](references/fmt-horizontal-alignment.md) - Avoid horizontal alignment - [`fmt-team-rules`](references/fmt-team-rules.md) - Follow team formatting rules - [`fmt-indentation`](references/fmt-indentation.md) - Respect indentation rules ### 5. Error Handling (HIGH) - [`err-use-exceptions`](references/err-use-exceptions.md) - Separate error handling from happy path - [`err-write-try-catch-first`](references/err-write-try-catch-first.md) - Write try-catch-finally first - [`err-provide-context`](references/err-provide-context.md) - Provide context with exceptions - [`err-define-by-caller-needs`](references/err-define-by-caller-needs.md) - Define exceptions by caller needs - [`err-avoid-null`](references/err-avoid-null.md) - Avoid returning and passing null ### 6. Objects and Data Structures (MEDIUM-HIGH) - [`obj-data-abstraction`](references/obj-data-abstraction.md) - Hide data behind abstractions - [`obj-data-object-asymmetry`](references/obj-data-object-asymmetry.md) - Understand data/object anti-symmetry - [`obj-law-of-demeter`](references/obj-law-of-demeter.md) - Follow the Law of Demeter - [`obj-avoid-hybrids`](references/obj-avoid-hybrids.md) - Avoid hybrid data-object structures - [`obj-dto`](references/obj-dto.md) - Use DTOs for data transfer ### 7. Boundaries (MEDIUM-HIGH) - [`bound-wrap-third-party`](references/bound-wrap-third-party.md) - Wrap third-party APIs - [`bound-learning-tests`](references/bound-learning-tests.md) - Write learning tests for third-party code ### 8. Classes and Systems (MEDIUM-HIGH) - [`class-small`](references/class-small.md) - Keep classes small - [`class-cohesion`](references/class-cohesion.md) - Maintain class cohesion - [`class-organize-for-change`](references/class-organize-for-change.md) - Organize classes for change - [`class-isolate-from-change`](references/class-isolate-from-change.md) - Isolate classes from change - [`class-separate-concerns`](references/class-separate-concerns.md) - Separate construction from use ### 9. Unit Tests (MEDIUM) - [`test-first-law`](references/test-first-law.md) - Follow the three laws of TDD - [`test-keep-clean`](references/test-keep-clean.md) - Keep tests clean - [`test-one-assert`](references/test-one-assert.md) - One concept per test - [`test-first-principles`](references/test-first-principles.md) - Follow FIRST principles - [`test-build-operate-check`](references/test-build-operate-check.md) - Use Build-Operate-Check pattern ### 10. Emergence and Simple Design (MEDIUM) - [`emerge-simple-design`](references/emerge-simple-design.md) - Follow the four rules of simple design - [`emerge-expressiveness`](references/emerge-expressiveness.md) - Maximize expressiveness ## How to Use Read individual reference files for detailed explanations and code examples: - [Section definitions](references/_sections.md) - Category structure and impact levels - [Rule template](assets/templates/_template.md) - Template for adding new rules ## Reference Files | File | Description | |------|-------------| | [references/_sections.md](references/_sections.md) | Category definitions and ordering | | [assets/templates/_template.md](assets/templates/_template.md) | Template for new rules | | [metadata.json](metadata.json) | Version and reference information |
© pproenca · MIT · pproenca/dot-skills
Похожие скиллы
Всё по теме «Код-ревью и рефакторинг» →Сначала — clean-code от других авторов.