Pular para o conteúdo principal
A Rules Library é um catálogo de Kody Rules prontas, agrupadas em packs por tema. Adicionar uma regra a copia para as suas regras, onde você pode editá-la, pausá-la ou excluí-la como qualquer outra.

Abra a biblioteca

  • Em Code review → Kody Rules, na aba Review Rules, clique em Discovery.
  • Em uma lista de regras vazia, clique em Browse the library. A lista também mostra três regras da biblioteca para você começar.
  • Busque por Rules library na paleta de comandos ⌘K.
O breadcrumb Kody Rules → Rules Library leva você de volta à página de regras de onde veio.

Encontre uma regra

A biblioteca tem duas visões, Featured e Browse, na navegação à esquerda.
  • Featured: Recommended for you, que sugere regras da biblioteca relacionadas ao que a Kody sinalizou recentemente nos seus repositórios conectados (Refresh recarrega), depois a coleção Plug and play e alguns packs.
  • Browse: todas as regras, 48 por vez (Load more para o restante).
Digitar em Search rules… muda para Browse. Em Browse você pode filtrar por: Browse abre filtrado pela linguagem do seu time quando a Kodus a conhece; escolha All em Language para limpar. Reset limpa os filtros que você definiu.

Packs

Um pack é um conjunto de regras em torno de um tema, como hardening de segurança, testes, observabilidade, acessibilidade, compliance (GDPR, HIPAA, SOC 2, PCI DSS, LGPD) ou uma stack (React, Next.js, Vue, Node.js, Python, PHP, Flutter). Browse all packs abre a página Rules Packs, onde você pode buscar packs e ver regras de exemplo; Explore pack abre as regras do pack em Browse.

Leia uma regra

Cada card mostra o título, a severidade, a linguagem e um badge Plug-and-Play nas regras que estão prontas para usar como estão. Clique em um card para abri-lo:
  • Why is it important?
  • Instructions: o texto que a Kody verifica.
  • Um Bad example e um Good example, quando a regra os tem.
Use o polegar para cima e o polegar para baixo para avaliar uma regra. O seu voto aparece no card.

Adicione regras

  1. Abra uma regra e clique na seta ao lado de Add to my rules.
  2. Escolha onde ela vai: Global, um ou mais repositórios, ou diretórios. Apenas os lugares onde você pode criar regras são listados. Escolher Global adiciona a regra somente ao Global, já que os repositórios a herdam.
  3. Clique em Add to my rules. Uma confirmação lista onde a regra foi adicionada.
Quando você abre uma regra a partir das três mostradas em uma página Kody Rules vazia, Add to my rules a adiciona diretamente a esse escopo e leva você de volta à página Kody Rules. Uma regra adicionada:
  • fica ativa, sempre roda Per file (mesmo que a regra da biblioteca descreva uma verificação do PR inteiro), mantém a severidade e os exemplos da biblioteca e mostra a origem Library;
  • não tem path, então se aplica a todos os arquivos, com duas exceções: uma regra com linguagem fica limitada aos arquivos dessa linguagem, e uma regra adicionada de dentro de um escopo de diretório recebe a primeira pasta desse diretório como path, <folder>/**;
  • conta para o limite de 10 regras ativas do plano Free. Além dele, a regra é adicionada, mas fica Locked. Veja limites de regras.
Se o seu workspace usa configuração centralizada, adicionar uma regra abre um pull request no repositório de configuração.