clean-code — правило для Cursor: что делает и как установить
Правило задаёт единый стиль для читаемого и поддерживаемого кода. Оно пригодится при написании, ревью и рефакторинге.
.cursor/rules/clean-code.mdcЧто делает clean-code
clean-code задаёт правила для имён переменных, функций и классов, именованных констант вместо магических чисел и комментариев, объясняющих причины решений. Оно также требует небольших функций с одной ответственностью, устранения повторов и понятной структуры файлов.
Правило охватывает рефакторинг, технический долг, тесты для ошибок и крайних случаев, а также практики Git: короткие тематические коммиты, ясные сообщения и осмысленные имена веток. Область действия указана как **/*, но alwaysApply имеет значение false, поэтому Cursor не применяет правило постоянно.
Чтобы подключить его в Cursor, создайте файл .cursor/rules/clean-code.mdc и поместите туда содержимое правила. Без этого файла Cursor не получит описанные требования.
Какие задачи решает
- заменить магические числа именованными константами
- разделить функции с несколькими обязанностями
- убрать повторяющуюся логику
- проверить имена и комментарии в коде
- подготовить читаемые тесты для ошибок и крайних случаев
Примеры запросов агенту
- Проверь этот файл по правилу clean-code и предложи точечный рефакторинг.
- Раздели функцию, которая делает несколько вещей, на небольшие функции с одной ответственностью.
- Перепиши повторяющуюся логику и замени магические числа именованными константами.
Как установить clean-code
Вручную: положить файлы
.cursor/rules/clean-code.mdcВо frontmatter: description, globs, alwaysApply
Вручную: положить файлы
.claude/rules/clean-code.mdПоле paths во frontmatter ограничивает файлы: globs из источника → paths
AGENTS.md
Codex читает AGENTS.md: вставьте текст правила туда
Вручную: положить файлы
.github/instructions/clean-code.instructions.mdПоле applyTo задаёт, к каким файлам применять: globs из источника → applyTo
Вручную: положить файлы
.devin/rules/clean-code.mdВручную: положить файлы
.clinerules/clean-code.mdПо шагам, с командами для каждой платформы: Cursor rules: файлы .mdc, четыре режима и замена .cursorrules
Вопросы о clean-code
Как установить clean-code в Cursor?
Создайте файл .cursor/rules/clean-code.mdc и поместите в него содержимое правила.
Что делает clean-code?
Правило направляет агента к понятным именам, небольшим функциям, единому источнику логики и читаемым тестам. Оно также задаёт требования к структуре кода и Git-коммитам.
Применяется ли clean-code ко всем файлам?
Область правила задана шаблоном **/*, но alwaysApply установлено в false, поэтому оно не включается постоянно.
Исходный текст
clean-code.mdc · CC0-1.0
--- description: Guidelines for writing clean, maintainable, and human-readable code. Apply these rules when writing or reviewing code to ensure consistency and quality. globs: ["**/*"] alwaysApply: false --- # Clean Code Guidelines ## Constants Over Magic Numbers - Replace hard-coded values with named constants - Use descriptive constant names that explain the value's purpose - Keep constants at the top of the file or in a dedicated constants file ## Meaningful Names - Variables, functions, and classes should reveal their purpose - Names should explain why something exists and how it's used - Avoid abbreviations unless they're universally understood ## Smart Comments - Don't comment on what the code does - make the code self-documenting - Use comments to explain why something is done a certain way - Document APIs, complex algorithms, and non-obvious side effects ## Single Responsibility - Each function should do exactly one thing - Functions should be small and focused - If a function needs a comment to explain what it does, it should be split ## DRY (Don't Repeat Yourself) - Extract repeated code into reusable functions - Share common logic through proper abstraction - Maintain single sources of truth ## Clean Structure - Keep related code together - Organize code in a logical hierarchy - Use consistent file and folder naming conventions ## Encapsulation - Hide implementation details - Expose clear interfaces - Move nested conditionals into well-named functions ## Code Quality Maintenance - Refactor continuously - Fix technical debt early - Leave code cleaner than you found it ## Testing - Write tests before fixing bugs - Keep tests readable and maintainable - Test edge cases and error conditions ## Version Control - Write clear commit messages - Make small, focused commits - Use meaningful branch names
© PatrickJS · CC0-1.0 · PatrickJS/awesome-cursorrules