25-clean-code

A set of clean-code rules for Java, TypeScript, and Kotlin. It covers responsibilities, naming, complexity, conditionals, comments, and removing unnecessary code.

In plain words
What is it for?
Use it during coding and review to split unrelated responsibilities, reduce nesting, choose clearer names, limit complex functions, and replace misleading comments with understandable code.
Why use it?
It gives consistent guidance for making code easier to read, test, and change. The rules help prevent overly complex functions, unclear names, and abstractions that do not solve a real problem.

Cursor rule

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/joaonic/agentkit/25-clean-code
Clone the repo
git clone --depth 1 https://github.com/Joaonic/agentkit
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 745 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.00745
Opus 5 $0.00000 $0.00373
Sonnet 5 $0.00000 $0.00149
Haiku 4.5 $0.00000 $0.00075

Measured yesterday against content hash a2ac4015e76e, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

25-clean-code scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

src/core/rules/25-clean-code.mdc · 52 lines

How it starts

The opening of the file, as written. The whole thing — 52 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Clean Code

Single Responsibility e Abstrações

  • SRP: Uma classe/função = uma responsabilidade clara. Se o nome precisar de "e" ou "ou", considere extrair.
  • OCP: Preferir abstrações para extensão sem alterar código existente. Não criar abstrações que não resolvem problema real.
  • Quando extrair: mesma lógica em 2+ lugares; ou módulo/classe faz mais de uma coisa distinta.

Complexidade e Legibilidade

  • Complexidade Ciclomática Máxima: Funções/métodos devem ter complexidade ciclomática ≤ 10. Se exceder, refature extraindo funções menores.
  • Complexidade Cognitiva: Evite aninhamento excessivo; use early returns; extraia funções para lógica complexa.
  • Early returns (Guard clauses): Coloque validações e null-checks no topo; mantenha o caminho feliz linear e ao final.
  • Código Auto-Explicativo: O código deve ser auto-explicativo através de nomes descritivos. Comentário inline para explicar "o quê" = código mal escrito.

Condicionais por Tipo e Enums

  • Evitar cadeias de if/else ou switch por tipo: quando houver 3+ ramos baseados em tipo de domínio, prefira Map/objeto indexado por enum.
  • Sempre usar enum, nunca string literal: magic strings de domínio SEMPRE substituídas por enums/constantes tipadas.
  • Switch com ≤ 2 casos: aceitável manter if/else simples, desde que enum seja usado.

Comentários e Documentação

  • EVITE comentários inline: o código deve ser auto-explicativo por nomes e estrutura.
  • Comentários permitidos apenas para:
    • Javadoc/JSDoc/TSDoc em APIs públicas (classes, métodos/funções exportados, componentes, hooks).
    • Decisões de design não óbvias ou trade-offs arquiteturais.
    • Restrições ou contexto que o código não pode expressar.
  • Código comentado = código morto: use git para histórico; remova código comentado.
  • Nomenclatura Descritiva: prefira nomes longos e descritivos a nomes curtos com comentários.

Limpeza de Passagem

  • Ao modificar um arquivo: faça limpeza necessária sem alterar API pública e sem quebrar testes.
  • Durante limpeza: remova comentários desnecessários, melhore nomes pouco descritivos, reduza complexidade, remova código morto, elimine imports não usados.
  • DRY: não repita lógica. Extraia para funções/utilitários/classes reutilizáveis.

Read the full file on GitHub · 52 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 52 lines · 0 tokens per session scan A a2ac4015e76e

Subscribe to this mod's changes

25-clean-code is a cursor rule published in the GitHub repository Joaonic/agentkit (2 stars, last pushed 3mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 745 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.