Visão Geral

​

Dois Tipos de Kody Rules

​

Regras de Revisão

​

Criar Regras Personalizadas

​

Variáveis, Referências a Arquivos e Funções MCP

• Nível de Arquivo:
  • fileDiff - As alterações específicas feitas no arquivo individual sendo analisado
• Nível de PR:
  • pr_title - O título do Pull Request
  • pr_description - A descrição/corpo do Pull Request
  • pr_total_additions - Total de linhas adicionadas
  • pr_total_deletions - Total de linhas removidas
  • pr_total_files - Total de arquivos alterados
  • pr_total_lines_changed - Total de linhas modificadas
  • pr_files_diff - Diff completo de todas as alterações em todo o Pull Request
  • pr_tags - Tags associadas ao Pull Request
  • pr_author - Autor do Pull Request
  • pr_number - Número do Pull Request

• @file:caminho/para/arquivo.ts - Referencie arquivos no mesmo repositório onde você está editando a regra
  • Use ao referenciar templates, exemplos ou arquivos de configuração dentro do seu repositório atual
  • Exemplo: @file:src/services/userService.ts
• @repo:org/projeto - Referencie arquivos em outro repositório ou ao configurar regras fora do contexto de um repositório
  • Use ao garantir consistência entre múltiplos repositórios ou ao referenciar padrões compartilhados
  • Exemplo: @repo:team/api-standards

• Kody identifica referências a arquivos automaticamente quando você salva uma regra
• As referências são resolvidas em segundo plano — observe o indicador de status ao lado do editor para confirmar a conclusão
• Use caminhos precisos no estilo blob (ex.: src/utils/helpers.ts) em vez de placeholders
• O conteúdo dos arquivos é injetado no contexto da regra, permitindo que Kody compare, valide ou aplique padrões
• Funciona em regras de Nível de Arquivo e de Pull Request

• Operações de repositório: Listar repositórios, obter arquivos, conteúdo e linguagens do repositório
• Análise de PR: Obter detalhes do pull request, listar commits, analisar conteúdo de arquivos do PR
• Recuperação de conteúdo de arquivos: Buscar conteúdo e diffs de arquivos
• Validação entre arquivos: Realizar análise avançada em múltiplos arquivos
• Integrações personalizadas: Qualquer servidor MCP que você conectou como plugin (Jira, ferramentas personalizadas, etc.)

• Use caminhos de arquivo específicos em vez de placeholders genéricos
• Referencie arquivos estáveis que representam os padrões da sua equipe
• Teste se as referências de arquivos existem antes de salvar as regras para evitar erros de resolução
• Combine variáveis, referências a arquivos e funções MCP para validação abrangente

​

Regras no Nível de Arquivo

• Comparar com arquivos de referência usando @file ou @repo
• Buscar arquivos relacionados ou dados do repositório usando funções MCP
• Combinar variáveis, referências a arquivos e funções MCP para validar padrões, verificar consistência ou aplicar regras arquiteturais

• Nome da regra: Defina claramente o propósito da regra
• Caminhos de Arquivo: Limite as regras a arquivos ou diretórios específicos usando padrões glob
• Severidade: Defina como Crítico, Alto, Médio ou Baixo
• Instruções Detalhadas: Use fileDiff, referencie arquivos com @file/@repo e chame funções MCP para compor regras poderosas com contexto rico

// Risk of infinite loop if increment is not exactly 1
for (let i = 0; i != 10; i += 2) {
  console.log(i); // Will print 0, 2, 4, 6, 8, 10, 12, 14... forever
}

// Risk if array is modified during iteration
let items = [1, 2, 3, 4, 5];
for (let i = 0; i != items.length; i++) {
  if (items[i] === 3) {
    items.push(6); // Modifies length, can cause infinite loop
  }
}

// Safe: loop will always terminate
for (let i = 0; i < 10; i += 2) {
  console.log(i); // Will print 0, 2, 4, 6, 8 and stop
}

// Safe even if array is modified
let items = [1, 2, 3, 4, 5];
for (let i = 0; i < items.length; i++) {
  if (items[i] === 3) {
    items.push(6); // Loop will still terminate safely
  }
}

​

Regras no Nível de Pull Request

• Validar metadados do PR usando variáveis como pr_title, pr_description, pr_author
• Referenciar arquivos de configuração ou templates usando @file ou @repo
• Buscar contexto adicional usando funções MCP (ex.: verificar se arquivos relacionados existem, validar em relação à estrutura do repositório)
• Combinar variáveis de PR, referências a arquivos e funções MCP para criar regras de validação abrangentes

• Todo arquivo de serviço deve ter um arquivo de teste correspondente
• A descrição do PR deve estar completa, informando claramente o que foi adicionado ou removido
• Quando uma nova rota é criada em um controller, ela deve ser registrada em routes.json
• Use pr_total_lines_changed para sinalizar PRs que excedem limites de tamanho
• Combine pr_files_diff com funções MCP para validar dependências entre arquivos
• Referencie @file:routes.json para garantir que novas rotas sejam registradas
• Use funções MCP para verificar se arquivos de teste existem para arquivos de serviço modificados

​

Compondo Regras Poderosas

• Use fileDiff para analisar as alterações específicas em um arquivo
• Referencie arquivos relacionados com @file:caminho/para/template.ts para comparar com padrões
• Chame funções MCP para buscar dados do repositório ou verificar se arquivos relacionados existem
• Exemplo: “Analise fileDiff e garanta que segue o padrão em @file:src/utils/example.ts. Use MCP para verificar se arquivos de teste relacionados existem.”

• Use variáveis de PR (pr_title, pr_description, pr_files_diff, etc.) para validar metadados e tamanho do PR
• Referencie arquivos de configuração com @file:config.json ou @repo:org/shared-config para garantir consistência
• Chame funções MCP para realizar validação entre arquivos, verificar a estrutura do repositório ou buscar histórico de commits
• Exemplo: “Se pr_files_diff contiver novas rotas, verifique se estão registradas em @file:routes.json. Use MCP para verificar se arquivos de teste correspondentes existem para todos os arquivos de serviço modificados.”

• Referencie arquivos de outros repositórios com @repo:org/projeto para manter consistência entre projetos
• Combine com funções MCP para validar em relação a padrões ou templates compartilhados
• Exemplo: “Garanta que os endpoints de API sigam o padrão definido em @repo:org/api-standards. Use MCP para buscar o documento de padrões mais recente.”

• As funções MCP são executadas durante a avaliação da regra, permitindo regras que se adaptam ao estado atual do repositório
• Busque dados em tempo real sobre arquivos, commits ou estrutura do repositório
• Exemplo: “Use MCP para verificar a estrutura atual do repositório e garantir que novos arquivos sigam os padrões de diretório existentes.”

​

Importar da Biblioteca de Regras

• Navegue até Descoberta de Regras no seu painel Kodus.
• Filtre regras por severidade, linguagem ou tags.
• Importe e ative regras com um único clique.

• Security: “Proibir uso de hash MD5 inseguro.”
• Maintainability: “Limitar componentes React a menos de 150 linhas.”

​

Memórias

​

Como as Memórias Funcionam

• Injetadas em todos os lugares: As Memórias são incluídas na análise de code review (entre arquivos, salvaguardas, regras no nível de PR) e nas interações conversacionais
• Contexto de alta prioridade: As Memórias são tratadas como orientações de alta prioridade pela IA, garantindo que as convenções da sua equipe sejam aplicadas consistentemente
• Deduplicação inteligente: Quando uma nova memória é criada, Kody usa um mecanismo de resolução baseado em LLM para determinar se deve criá-la, ignorá-la (se duplicada) ou atualizar uma memória existente

​

Criando Memórias

​

Via Conversa

@kody remember: API payload keys are camelCase, database columns are snake_case.

@kody please remember: in the domain layer, entities must never have nullable properties by default.

@kody in this repo we avoid Lodash and prefer native JS array methods for readability and bundle size.

@kody for existence checks in Postgres we prefer EXISTS over COUNT(*) and over broad LEFT JOIN patterns for performance.

@kody we're migrating from AWS SDK v2 to v3; treat any new v2 import as blocker.

​

Via Interface

1. Acesse Configurações de Code Review → Repositório → Kody Rules
2. Mude para a aba Memórias
3. Clique em Adicionar Memória para criar uma nova entrada
4. Preencha o conteúdo da memória e o escopo

​

Escopos de Memória

​

Aprovação de Memórias Geradas por LLM

1. Acesse Configurações de Code Review → Repositório → Kody Rules → aba Memórias
2. Habilite Aprovação de memórias geradas por LLM

• Memórias geradas por IA entram em um estado pendente e não ficam ativas até serem aprovadas
• Um badge de notificação aparece mostrando a contagem de memórias pendentes
• Clique em Memórias Pendentes para revisar, aprovar, descartar ou converter itens pendentes
• Tanto a criação de novas memórias quanto as atualizações de memórias existentes passam pelo fluxo de aprovação

llmGeneratedMemoriesRequireApproval: true

​

Revisão de Memórias Pendentes

• Novas Memórias: Memórias geradas por IA aguardando aprovação
• Atualizações de Memória: Alterações propostas para memórias existentes

• Aplicar: Ativar a memória ou aplicar a atualização
• Descartar: Rejeitar a memória ou atualização
• Converter em Regra de Revisão: Transformar uma memória em uma Regra de Revisão padrão

​

Próximos Passos