Навык clean-code
✓ ПровереноСоблюдает стандарты кодирования, такие как принцип единственной ответственности, ясность именований и управление сложностью при генерации или изменении кода реализации.
- Звёзды на GitHub
- 211
- Файлы
- 2
- Последний коммит
- 24 окт. 2026 г.
- Лицензия
- MIT
- Разрешённые инструменты
- —
Что делает навык clean-code?
Соблюдает стандарты кодирования, такие как принцип единственной ответственности, ясность именований и управление сложностью при генерации или изменении кода реализации.
Сводка сгенерирована из SKILL.md навыка.
О skill clean-code
Основная функция этого SKILL — поддержание высокого качества реализации в процессе написания кода. Он предназначен для разработчиков, которым необходимо гарантировать, что каждая отдельная единица кода соответствует строгим стандартам ясности именований, принципу единственной ответственности и управления сложностью. Навык автоматически загружается специализированными агентами, такими как code-forge, refactor-safely и bug-fix, когда пользователь запрашивает улучшение качества кода или соблюдение конкретных правил кодирования.
Вместо того чтобы фокусироваться на общей архитектуре или безопасности, этот инструмент управляет процессом написания конкретных функций и переменных. Он опирается на систему конфигурации, которая считывает .lattice/config.yaml для применения пользовательских стандартов или языковых идиом для обработки ошибок и систем типов. Навык использует чек-лист самопроверки для мониторинга размера функций, цикломатической сложности и количества параметров, гарантируя, что код остается самодокументированным и удобным для тестирования. Он также проводит активное сканирование на наличие антипаттернов, таких как глубокая вложенность, криптические имена и подавленные ошибки, чтобы предотвратить накопление технического долга в кодовой базе.
Что агент может делать с ним
- 1Соблюдение принципа единственной ответственности в функцияхПопросите агента провести рефакторинг большой функции, выполняющей несколько задач, разбив её на более мелкие и специализированные единицы.
- 2Снижение цикломатической сложностиПопросите агента упростить сложную условную логику внутри конкретного блока кода.
- 3Улучшение именования переменных и функцийДайте инструкции ИИ переименовать переменные и функции так, чтобы их назначение было понятно без дополнительных комментариев.
Написано на основе skill SKILL.md. Каждый сценарий использования проверен по цитате из него.
Как установить навык clean-code
Каждая команда копирует папку навыка в каталог навыков клиента. Перезапустите клиент или начните новую сессию, чтобы загрузить его.Установка навыка clean-code в Плагин
/plugin marketplace add techygarg/lattice /plugin install lattice@lattice
Установка навыка clean-code в Claude Code
~/.claude/skills/clean-code/SKILL.md
$ npx degit techygarg/lattice/skills/clean-code ~/.claude/skills/clean-codeУстановка навыка clean-code в Claude Code (project)
.claude/skills/clean-code/SKILL.md
$ npx degit techygarg/lattice/skills/clean-code .claude/skills/clean-codeУстановка навыка clean-code в Codex
~/.agents/skills/clean-code/SKILL.md
$ npx degit techygarg/lattice/skills/clean-code ~/.agents/skills/clean-codeУстановка навыка clean-code в Gemini CLI
~/.gemini/skills/clean-code/SKILL.md
$ npx degit techygarg/lattice/skills/clean-code ~/.gemini/skills/clean-codeУстановка навыка clean-code в Claude.ai
npx degit techygarg/lattice/skills/clean-code clean-code && zip -r clean-code.zip clean-code # claude.ai → Customize → Skills → + → Create skill → Upload a skill → clean-code.zip
Автоматические проверки
Запущено 15 нояб. 2026 г.Полный отчёт →Прошёл наши автоматические проверки. Это не аудит безопасности: прочитайте скрипты, прежде чем агент их запустит. Как работают проверки
- Связанный и доступный исходный репозиторийtechygarg/lattice/skills/clean-code is public and reachablegithub.com/techygarg/lattice/tree/HEAD/skills/clean-code ↗Пройдено
- Open source лицензия (OSI)MITspdx.org/licenses/MIT.html ↗Пройдено
- Коммит или релиз за последний годLast commit 2026-10-24github.com/techygarg/lattice/commits ↗Пройдено
- В скриптах нет загрузки с запуском и кражи учётных данныхNo scripts in the skill folderПройдено
- В SKILL.md нет скрытых инструкцийNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/techygarg/lattice/blob/HEAD/skills/clean-code/SKI ↗Пройдено
- Заранее разрешённые инструменты ограниченыNo pre-approved tools; the agent asks before using onegithub.com/techygarg/lattice/blob/HEAD/skills/clean-code/SKI ↗Пройдено
- SKILL.md соответствует формату Agent SkillsValid name and description; says when to use it; 65 linesgithub.com/techygarg/lattice/blob/HEAD/skills/clean-code/SKI ↗Пройдено
SKILL.md
Открыть на GitHubClean Code
Config Resolution
Projects can customize this skill's standards. Resolution order:
- Read
.lattice/config.yamlin the repo root. - If found, check
paths.clean_codefor a custom document path. - If a custom document exists at that path, read it and check its YAML frontmatter for
mode:mode: override: the custom document has full precedence. Use it instead of the embedded defaults. It must be comprehensive -- treat it as the sole reference.mode: overlay(or no mode field): read the embedded./references/defaults.mdfirst, then apply the custom document's sections on top. A custom section replaces the matching default section (matched by exact heading); new sections append after the defaults.
- If a custom path is configured but no document exists at it → tell the user which configured path is missing, then fall back to
./references/defaults.md. - If there is no config file or no
paths.clean_codekey, read./references/defaults.md. - Language adaptation: if
paths.language_idiomsis set in the config and the document exists, read it and adapt the defaults using these sections:- "Error Handling" → adapt §8 (Error Handling) patterns to the language's idioms. Language idioms take precedence over the pseudocode defaults.
- "Type System & Object Model" → adapt §1 (Single Responsibility) cohesion guidance to the language's constructs (e.g., struct vs class).
- "Naming Conventions" → adapt §4 (Meaningful Naming) patterns to the language's conventions.
- "Parameter & Function Design" → adapt §2 (Small, Focused Functions) and §5 (Parameter Design) to the language's capabilities.
- "Dependency Management" → adapt §9 (Test-Friendly Code) dependency-injection patterns to the language's idioms.
Self-Validation Checklist
STOP after generating each component. Verify ALL checks. Fix every failed check before presenting. Judgment calls → present options (see Ambiguity Signals).
- SINGLE RESPONSIBILITY: Can you describe each function without "and"? If not → extract a separate function.
- SIZE: Is each function under the size threshold from the loaded doc (~20 lines default)? If not → extract a sub-operation into its own named function.
- COMPLEXITY: Is cyclomatic complexity under the threshold from the loaded doc (~10 default)? If not → flatten with a guard clause or extract a branch.
- ABSTRACTION LEVEL: Does each function operate at one level of abstraction? If high-level logic mixes with low-level detail → extract the detail.
- NAMING: Does each function/variable name reveal intent without needing surrounding context? If not → rename to be self-documenting.
- PARAMETERS: Is the parameter count under the threshold from the loaded doc (4 default)? If not → group parameters into an object.
- PRIMITIVE OBSESSION: Would a string/number/boolean be clearer as a named type? If so → introduce a parameter object or typed wrapper.
- ERROR HANDLING: Does every fail-able operation have explicit handling with an actionable message? Is it handled at the right level?
Project-specific checks: if the loaded doc (from Config Resolution) contains a Validation Checklist section (§10 from the clean-code-refiner template), apply those checks as additional project-specific validation after the checklist above.
All checks pass → state "Passes clean-code. [next step]."
Active Anti-Pattern Scan
After the checklist, scan for each of these. Any box you can check → fix before presenting.
- God Function: a function exceeds ~30 lines doing multiple things; describing it requires "and" → extract focused functions.
- Deep Nesting: three or more levels of indentation → flatten with early returns / guard clauses.
- Cryptic Naming: variables like
d,tmp2,processData→ rename to reveal intent. - Long Parameter Lists: five or more parameters → group into an object or split the function.
- Premature Abstraction: a utility extracted from only two similar blocks → inline it until the Rule of Three (third instance with the same reason to change).
- Swallowed Errors: empty catch blocks, generic "something went wrong" messages, silent null returns → handle explicitly.
- Comments as Deodorant: a comment explains convoluted code instead of the code being fixed → rename to self-document; keep only "why" comments, remove "what" comments.
- Hidden Side Effects: a function named
getXalso writes a cache or sends notifications → rename or separate the concern. - Dead Code: commented-out blocks, unused imports, unreachable branches → delete them (version control preserves history).
- Untestable Logic: side effects tangled with business logic; unit testing requires mocking I/O → push side effects to the boundary, extract pure functions, inject dependencies.
Ambiguity Signals
Multiple valid outcomes exist. Present the options rather than silently choosing. If framework:collaborative-judgment is loaded, use its presentation format. See ./references/defaults.md for resolution guidance on each signal below.
- Single Responsibility: two tightly-coupled sequential operations may be one responsibility (a pipeline), not two. The "and" test catches true violations AND false positives.
- Function Size: near-threshold size (20–30 lines) with one clear purpose -- extraction may create five unclear smaller functions. Present the tradeoff.
- DRY vs Premature Abstraction: two identical blocks may serve different purposes and diverge independently. Until a third instance with the same reason to change appears, this is genuinely ambiguous.
- Error Handling Strategy: exception vs Result type vs error codes depends on language idiom and team convention, not on universal rules.
Файлы в этом навыке
2Вопросы о навыке clean-code
Как установить навык clean-code в Claude Code?
Выполните npx degit techygarg/lattice/skills/clean-code ~/.claude/skills/clean-code. Claude Code загружает навыки из ~/.claude/skills (все проекты) или .claude/skills (один проект) и использует навык, когда его описание соответствует задаче.
Какие клиенты могут использовать навык clean-code?
Любой клиент, который читает формат Agent Skills: Claude Code, Codex, Gemini CLI и claude.ai (загрузить как ZIP). Скрипты в навыке выполняются только там, где клиент разрешает выполнение кода.
Какие по умолчанию установлены пороги размера и сложности функций?
По умолчанию функции должны содержать не более 20 строк, а их цикломатическая сложность не должна превышать 10.
Как проект может настроить стандарты чистого кода?
Проекты могут настроить стандарты, указав путь к пользовательскому документу в .lattice/config.yaml, используя режим 'override' для полного приоритета или режим 'overlay' для дополнения стандартных правил.