К основному содержанию
правило

clean-code — правило для Cursor: что делает и как установить

Правило задаёт единый стиль для читаемого и поддерживаемого кода. Оно пригодится при написании, ревью и рефакторинге.

Установить в Cursor · Вручную: положить файлы Все способы и платформы ↓
.cursor/rules/clean-code.mdc
Открыть на GitHub

Что делает 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

По шагам, с командами для каждой платформы: 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

Похожие правила IDE

Все правила IDE по теме «Код-ревью и рефакторинг» →
springboot официальный github Правило задаёт Copilot стиль кода для Spring Boot: внедрение зависимостей, конфигурация, логирование и проверка сборки. ★ 40 451звёзд репо springboot-4-migration официальный github Инструкция для GitHub Copilot по переводу проектов со Spring Boot 3.x на 4.0. Помогает обновить зависимости в Gradle Kotlin DSL, каталоги версий и имена стартеров. ★ 40 451звёзд репо self-explanatory-code-commenting официальный github Инструкция для GitHub Copilot, которая запрещает очевидные комментарии к коду и требует пояснять только неочевидные решения, бизнес-логику или ограничения API. ★ 40 451звёзд репо scala2 официальный github Правило задаёт Copilot стиль Scala по гайду Databricks: неизменяемость, чистые функции, именование. Пригодится, если пишете на Scala 2.12 или 2.13. ★ 40 451звёзд репо power-bi-dax-best-practices официальный github Задаёт стандарты написания формул DAX для GitHub Copilot при работе с файлами .pbix, .dax, .md и .txt. Помогает избежать ошибок в фильтрации и повысить скорость вычислений. ★ 40 451звёзд репо oop-design-patterns официальный github Правило для GitHub Copilot, которое подталкивает его к паттернам GoF и принципам SOLID при генерации и рефакторинге ООП-кода. ★ 40 451звёзд репо

Из того же набора140

code-pair-interviews Правило настраивает Cursor на стиль парного собеседования: требует составлять план решения, писать читаемый код с понятными именами и проверять граничные случаи. ★ 41 024звёзд репо code-guidelines-cursorrules-prompt-file Правило задаёт Cursor порядок работы с кодом: проверять факты, сохранять существующую структуру и учитывать тесты, безопасность и совместимость. ★ 41 024звёзд репо cloudflare-workers-hono-angular-saas-cursorrules-prompt-file Правило для Cursor задаёт стек и соглашения для SaaS на Cloudflare Workers: Hono API, Angular, Drizzle, Clerk, Stripe. ★ 41 024звёзд репо cloudflare-email-telegram-cursorrules-prompt-file Инструктирует Cursor по настройке пересылки писем с домена в Telegram через Cloudflare Workers и утилиту mail2tg. ★ 41 024звёзд репо chrome-extension-dev-js-typescript-cursorrules-pro Правило для Cursor, которое настраивает агента писать код расширений Chrome на JavaScript и TypeScript по единому своду соглашений. ★ 41 024звёзд репо blender-python-addon Свод правил для разработки расширений к Blender на Python. Задаёт стандарты для операторов, панелей интерфейса и безопасного вызова Blender API в Cursor. ★ 41 024звёзд репо beefreesdk Правило задаёт Cursor структуру интеграции Beefree SDK: установку, авторизацию через прокси, контейнер, конфигурацию и callback-функции. ★ 41 024звёзд репо beefreesdk-nocode-content-editor-cursorrules-prompt-file Правило Cursor, которое ведёт агента при встраивании редакторов Beefree SDK для писем, страниц и попапов в веб-приложение. ★ 41 024звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой