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

module-shape — правило для Claude Code: модули и установка

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

MIT ★ 2 966 обновлён 2026-09-29

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

Что делает module-shape

Правило предлагает оставлять у модуля небольшую публичную поверхность, скрывая внутри алгоритмы, ветвления, состояния, повторы и кэширование. Перед добавлением нового экспорта стоит проверить, может ли существующий принять эту логику. При удалении — не стал ли модуль слишком тонким для отдельного существования.

Внешние зависимости передаются через аргументы, а бизнес-логика не создаёт клиентов, не читает конфигурацию и не обращается к часам сама. Функции должны возвращать значения, а не менять входные объекты. Моки нужны на границах системы: для HTTP API, базы данных, часов, случайности и файловой системы. Если код внутри бизнес-логики сам создаёт внешний клиент, это нарушение правила. Для таких границ предлагаются моки, повторяющие форму конкретных конечных точек.

Какие задачи решает

  • сузить публичный интерфейс модуля
  • спрятать ветвления и состояние за API
  • передать внешние зависимости через аргументы
  • проверить границы для моков на ревью

Примеры запросов агенту

  • Проверь этот модуль по правилу module-shape и укажи лишние публичные методы.
  • Перепиши функцию так, чтобы внешний клиент передавался аргументом, а бизнес-логика возвращала значение.
  • Проведи ревью тестов: найди моки внутренних классов и замени их проверкой границ системы.

Как установить module-shape

Вручную: положить файлы

.cursor/rules/module-shape.mdc

Во frontmatter: description, globs, alwaysApply

По шагам, с командами для каждой платформы: Cursor rules: файлы .mdc, четыре режима и замена .cursorrules

Вопросы о module-shape

Как установить module-shape в Claude Code?

Добавьте маркетплейс командой /plugin marketplace add rohitg00/pro-workflow, установите плагин через /plugin install pro-workflow@pro-workflow, затем разместите правило по пути .claude/rules/module-shape.md.

Что делает правило module-shape?

Оно задаёт принципы проектирования модулей: узкий публичный интерфейс, скрытая внутренняя сложность, передача зависимостей через аргументы и моки только на системных границах.

Что именно можно мокать по этому правилу?

Мокать следует внешние HTTP API, базы данных при отсутствии реального тестового экземпляра, часы, источники случайности и файловую систему. Собственные модули и внутренние классы предлагается создавать напрямую.

Исходный текст

module-shape.mdc · MIT
---
description: Prefer modules with a narrow public surface and a thick internal implementation. Inject external dependencies at the boundary. Mock only at system edges.
globs:
alwaysApply: true
---

# Module Shape

## Surface vs. depth

A module's **surface** is every symbol a caller can touch: exported
functions, class methods, config parameters, flags. A module's **depth**
is everything hidden behind that surface: algorithms, branching, state
machines, retries, caching.

Aim for **narrow surface, thick depth**. A three-method module that hides
a hundred lines of branching is strong. A thirty-method module whose
methods each forward a single call to a dependency is weak — it leaks
complexity upward without doing work.

When adding a public export, first ask whether an existing one can absorb
the new behavior. When removing, first ask whether the module has gone
shallow and should be inlined into its only caller.

## Dependency direction

Accept dependencies as arguments. Do not construct external clients,
fetch configuration, or read the clock inside business logic.

```ts
// strong: the caller owns lifecycle, the test swaps the gateway
function chargeOrder(order, gateway) { return gateway.charge(order.total); }

// weak: business logic welds itself to a vendor and a credential source
function chargeOrder(order) {
  const gateway = new AcmePay(process.env.ACME_KEY);
  return gateway.charge(order.total);
}
```

Return values, do not mutate inputs. `computeDiscount(cart) -> Discount`
beats `applyDiscount(cart) -> void`. Pure returns are traceable; hidden
mutation is not.

## Where mocks belong

Mock at system boundaries only: third-party HTTP APIs, databases when a
real test instance is not available, the clock, random sources, the
filesystem when tests must stay hermetic.

Do not mock your own modules, internal classes, or anything you can
instantiate cheaply. A test whose setup is twenty lines of mock wiring is
telling you the module underneath is too shallow — fix the shape, not
the test.

At the real boundaries, prefer **endpoint-shaped** mocks over generic
ones. `{ getUser(id), createOrder(data) }` beats `{ request(path, opts) }`
because each mock returns one shape, test setup contains no conditionals,
and a reader can see which calls a test exercises.

## Checklist when reviewing

- [ ] Does every public symbol justify its presence? Delete or merge the rest.
- [ ] Are dependencies passed in, or constructed inside?
- [ ] Do tests mock anything the module itself owns? If yes, the shape is wrong.

© Rohit Ghumare · MIT · rohitg00/pro-workflow

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

Все правила IDE по теме «Код-ревью и рефакторинг» →
nginx-c-module-design pproenca Скилл nginx-c-module-design для Claude Code, Codex, Cursor и других агентов: 46 правил по проектированию директив nginx C-модулей. Охватывает именование, выбор скоупа, значения по умолчанию, валидацию и совместимость. CX Codex +1 382установок nestjs-best-practices Kadajett Скилл nestjs-best-practices для Claude Code помогает писать, проверять и рефакторить код NestJS. Он подключается к задачам по архитектуре, безопасности и производительности. CX Codex +1 32 000установок migrate-static-to-wrapper dotnet Скилл migrate-static-to-wrapper меняет статические вызовы в C# на инжектируемые абстракции: DateTime.UtcNow на TimeProvider, File.* на IFileSystem. Работает в границах одного файла, проекта или неймспейса. CX Codex +1 4 300установок nestjs-code-review giuseppe-trisciuoglio Скилл nestjs-code-review для ревью NestJS-приложений: проверяет контроллеры, сервисы, модули, DI, гарды и работу с базой. Пригодится перед мержем пул-реквеста. CX Codex +1 4 000установок nestjs-expert https://github.com/Jeffallan Скилл nestjs-expert для Claude Code и Codex помогает проектировать и писать NestJS-бэкенды на TypeScript. Создаёт REST API и GraphQL с enterprise-паттернами. CX Codex +1 6 400установок generate-testability-wrappers dotnet Скилл generate-testability-wrappers для Claude Code, Codex, Cursor и других платформ генерирует обёртки над статическими зависимостями C#, чтобы их можно было подменить в тестах. CX Codex +1 4 400установок

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

Весь набор →
file-watcher Скилл file-watcher настраивает хуки Claude Code для отслеживания изменений в .env, package.json и конфигурациях проекта. CX Codex +1 ★ 2 966звёзд репо commit Команда commit собирает изменения в осмысленный git-коммит после линтера, проверки типов и тестов. Подходит для контролируемого завершения работы над задачей. CX Codex +1 ★ 2 966звёзд репо mcp-audit Скилл mcp-audit анализирует подключённые MCP-серверы на предмет токенов, дублирования и безопасности. Запускай, когда сессии медлят или перед добавлением нового сервера. CX Codex +1 ★ 2 966звёзд репо tdd Скилл tdd задаёт для Claude Code цикл разработки через тесты: сначала падающий тест, затем минимальный рабочий код и рефакторинг. CX Codex +1 ★ 2 966звёзд репо improve-architecture Скилл improve-architecture диагностирует проблемы архитектуры кода — запутанные границы, дублирование, неправильные швы — и предлагает приоритизированный план минимальных изменений без переписи. CX Codex +1 ★ 2 966звёзд репо parallel-worktrees Скилл parallel-worktrees для Claude Code создаёт изолированные git-worktrees и запускает параллельные сеансы кодирования. Пока тесты или сборка идут в одном окне, начните новую задачу в другом — без ожидания и переключения контекста. CX Codex +1 ★ 2 966звёзд репо compact-guard Скилл compact-guard для Claude Code сохраняет состояние задачи перед сжатием контекста и помогает восстановить работу после него. Запускается перед /compact или при предупреждении об автосжатии. CX Codex +1 ★ 2 966звёзд репо handoff Команда handoff создаёт структурированный документ для передачи сессии другому Claude или себе в будущем. Содержит статус, решения, найденные ошибки и точку возобновления. CX Codex +1 ★ 2 966звёзд репо

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

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