agentleFS
lglucaslglucas/ai-dev-operating-system/.claude/skills/codemap/SKILL.md

codemap

Skill12 starsChanged 45 days agoMITView on GitHub

Mantém o CODEMAP.md — o índice de todo arquivo de código do projeto com uma linha sobre o núcleo de cada um, para achar arquivo sem ler o repositório inteiro. Regenere sempre que a lista, a descrição ou a contagem de linhas mudar — na prática, junto com qualquer edição de código —, ao fechar sprint e antes de release. Use quando o usuário disser "onde fica o arquivo de X?", "que arquivos mexem com Y?", "atualiza o mapa", "cadê o código que faz isso?" — ou quando você mesmo estiver prestes a varrer o repo procurando alguma coisa.

16 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use clonedeps and simplify.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • mike22890Skill

    clonedeps

    将项目依赖的第三方库源码克隆到本地,便于深入阅读和调试。当需要查看库的实现细节、阅读源码、调试第三方依赖、理解 SDK/framework 内部机制、查看 node_modules 之外的原始代码、分析开源库架构、学习他人代码、查看依赖的 TypeScript 类型定义时使用。

    Also in 4 projects that use this

  • Hugging FaceSkill

    simplify

    Refactor code after tests pass. The "Refactor" phase of Red-Green-Refactor.

    Also in 4 projects that use this

The file

We split this skill into the rules it gives an agent

1 rule. 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 15 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Do cabeçalho que a code-style já exige:

    line 47

“Common” is measured: kept by at least 6 in 10 of the 15 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Codemap

Antes de procurar, leia o mapa

Se você está prestes a varrer o projeto atrás de um arquivo — pare e leia o CODEMAP.md primeiro. É uma leitura contra dezenas. É literalmente para isso que ele existe.

Se o arquivo não existir, verifique o marcador .aios-self antes de estranhar: dentro do repositório do próprio AI Dev OS não há mapa por design (veja Escopo), e nesse caso procurar direto é o certo. Em projeto derivado, mapa ausente significa que ninguém rodou o gerador ainda — rode.

Se o mapa existe mas não responde, aí sim procure. E quando achar, considere se a descrição daquele arquivo estava ruim: o conserto é melhorar o cabeçalho Purpose: dele.

Regenerar

node scripts/codemap.js

Sobrescreve o CODEMAP.md inteiro. Nunca edite o arquivo à mão — a próxima geração desfaz.

Para verificar sem escrever, como o CI faz:

node scripts/codemap.js --check

Quando regenerar

MomentoPor quê
Criou, removeu, renomeou ou moveu arquivo de códigoa lista fica errada na hora
Mudou o Purpose: de um arquivoa descrição no mapa fica velha
Mudou o número de linhas de um arquivoo mapa grava a contagem exata
Ao fechar sprintsprint-management já toca changelog e docs; o mapa vai junto
Antes de releaserelease-check delega para cá
Depois de refatoração que moveu arquivosé quando o mapa mais diverge

A terceira linha é a que pega desprevenido: como o mapa grava a contagem exata, editar o corpo de um arquivo já mapeado costuma bastar para o --check acusar divergência. Regenere junto com a mudança e comite os dois — é mais barato que descobrir pelo CI vermelho.

O limite de 200 linhas continua sendo só um aviso no mapa, não o gatilho da regeneração. O gatilho é a contagem mudar, qualquer que seja o valor.

De onde vem a descrição

Do cabeçalho que a code-style já exige:

/**
 * Purpose: o que este arquivo resolve, em uma frase.
 * Version: v0.1.0
 * Sprint:  01
 */

Ordem de fallback: Purpose: → primeira frase do bloco de comentário → primeiro comentário de linha → ⚠️ sem cabeçalho.

Esse último caso é intencional. Arquivo sem cabeçalho aparece marcado no mapa, ou seja, o codemap acaba fiscalizando a regra de cabeçalho como efeito colateral. Se a descrição de um arquivo ficou ruim, o defeito está no cabeçalho, não no script.

Os dois avisos que o mapa emite

  • Acima de 200 linhas — a code-style pede "under 200 where practical". O mapa lista quem passou, para você decidir se separa ou aceita.
  • Sem cabeçalho Purpose: — cada um é uma linha ruim no mapa.

Nenhum dos dois bloqueia. O que bloqueia é o mapa estar desatualizado.

Por que isso importa mais do que parece

Arquivo curto e mapa de uma linha por arquivo servem à mesma coisa: menos token lido por tarefa. Sem o mapa, a IA abre dez arquivos para achar um. Com o mapa, abre um.

É por isso que o CI falha quando ele diverge. Codemap desatualizado é pior que nenhum — a IA confia, pula a leitura, e age sobre informação errada.

Escopo

Mapeia o código do projeto derivado. Dentro do repositório do AI Dev OS o script se desliga e sai com 0: o OS entrega a maquinaria, o projeto é que tem o código.

Related

  • Script: scripts/codemap.js
  • Regra: codemap · par com code-style
  • Fecha sprint com: sprint-management
  • Gate de release: release-check

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.