Operação do pipeline: análise de código
Escrito para a interface antiga
Este artigo foi escrito para a interface antiga. As instruções ainda podem ser usadas, mas as capturas de tela estão desatualizadas. Em alguns casos, os itens referenciados nas instruções foram movidos ou alterados. Se você não conseguir encontrar um item, consulte o Para onde foi artigo.
Visão geral
A Verificação de Código a operação analisa seus metadados do Salesforce para identificar problemas de qualidade de código antes da implantação. Por meio de análise estática de código, ela relata violações de regras em classes Apex, triggers e outros componentes de uma branch para confirmar que atendem aos seus padrões de codificação definidos. O conjunto de regras da Verificação de Código abrange:
Estilo de Codificação e Boas Práticas: Melhore a legibilidade, a manutenção e a consistência em toda a sua base de código.
Boas Práticas de Segurança: Identifique vulnerabilidades comuns e padrões de risco no seu código.
Sugestões de Desempenho: Destaque lógica ineficiente antes que ela afete os usuários finais.
Você pode definir um limite de severidade para interromper o pipeline quando as violações atingirem ou excederem um nível especificado. Executar Verificações de Código no seu pipeline ajuda a manter uma qualidade de código consistente e permite implantar componentes confiáveis, seguros e responsivos.
Este artigo explica como configurar e usar a operação Verificação de Código. Veja as seções a seguir para saber mais:
Boas práticas
Execute Verificações de Código automaticamente antes de cada implantação.
Defina limites de severidade com base nas regras de CI/CD.
Revise regularmente o Resultado da Verificação de Código e corrija problemas recorrentes.
Combine Verificação de Código com uma Etapa Manual para exigir revisão e aprovação antes da implantação em produção.
Mantenha configurações Verificação de Código consistentes em todos os ambientes.
Tipos de Verificação
A operação Verificação de Código oferece suporte a dois tipos de verificação: Apex PMD e Flosum Scan. Leia as descrições abaixo para escolher o tipo de verificação que melhor corresponda aos padrões de qualidade da sua equipe.
Apex PMD
Apex PMD é um conjunto de regras de código aberto que detecta problemas comuns em componentes do Salesforce. Ele inclui menos regras do que o Flosum Scan e conclui as verificações mais rapidamente, sendo uma opção leve para feedback rápido. Escolha o Apex PMD quando suas verificações básicas atenderem às suas necessidades ou quando você preferir detectar menos problemas.
Flosum Scan
Flosum Scan é o conjunto de regras mais abrangente do DevOps, desenvolvido para equipes que exigem o mais alto padrão de qualidade de código. Ele inclui todas as regras do Apex PMD, além de centenas de verificações adicionais, cerca de 6 vezes a cobertura do Apex PMD, e estende a análise estática para linguagens que o Apex PMD não cobre, incluindo Salesforce Flow e TypeScript. Essa cobertura expandida oferece análise mais profunda e validação mais rigorosa, dando mais confiança a cada implantação. Escolha o Flosum Scan para a proteção mais completa do seu código Salesforce.
Por que o Flosum Scan?
Cobertura mais ampla de linguagens: Adiciona suporte nativo a Salesforce Flow e TypeScript, nenhum dos quais é analisado por Apex PMD.
Cobertura mais profunda de Lightning: Inclui 381 regras para JavaScript e Lightning Web Components, em comparação com 19 no Apex PMD.
Validação de metadados mais robusta: Aplica 18 regras a Metadados do Salesforce, em comparação com 2 no Apex PMD.
Expansão contínua: O Flosum Scan conjunto de regras é mantido pela Flosum e continuará crescendo para acompanhar as mudanças na plataforma Salesforce.
Cobertura de regras por linguagem
A tabela abaixo lista as linguagens suportadas por cada tipo de verificação. O gráfico compara a cobertura de regras de cada tipo de verificação nas linguagens suportadas. Use essas informações para confirmar que o tipo de verificação selecionado oferece conjuntos de regras suficientes para as linguagens usadas na sua branch.
JavaScript / Lightning Web Components
TypeScript
Apex
Metadados do Salesforce
HTML / Salesforce Lightning Design System
Salesforce Flow
Visualforce
Níveis de severidade
Quando a Verificação de Código encontra um problema, ela atribui um Nível de Severidade que reflete o quão crítico o problema é para a qualidade do seu código. Use esses níveis para priorizar correções e definir o limite de severidade que determina quando a operação falha.
Bloqueador
Riscos graves de segurança ou bugs críticos que podem causar falha do sistema ou perda de dados.
Crítico
Problemas significativos que normalmente violam os padrões do Salesforce AppExchange.
Maior
Violações de boas práticas ou problemas de desempenho que afetam a manutenção.
Menor
Problemas de qualidade de código de baixo impacto ou inconsistências de estilo.
Informações
Mensagens informativas que não exigem ação.
Configuração da operação Verificação de Código
Selecione a operação e o tipo
Clique na menu suspenso menu suspenso.
Selecione Verificação de Código.
Clique na Tipo de verificação menu suspenso.
Selecione o tipo de verificação de código a ser executado. Consulte a Operação do pipeline: análise de código seção acima para mais detalhes.
Insira a descrição e o limite
(Opcional) No Descrição campo de texto, insira um resumo do que esta Verificação de Código executa.
Clique na Limite de severidade menu suspenso.
Selecione o nível mínimo de severidade que fará com que a operação Verificação de Código falhe. Consulte a Operação do pipeline: análise de código seção acima para mais detalhes.
Resultados da Verificação de Código
Resumo e log
Depois que a Verificação de Código for concluída, você pode ver o resumo dos resultados selecionando o Verificação de Código etapa nos resultados do pipeline.
A Resumo dos resultados da Verificação de Código exibe as seguintes informações:
Status
Concluído se todos os problemas encontrados estiverem abaixo do Limite de Severidade definido.
Exceção se qualquer problema atingir ou exceder o Limite de Severidade.
Duração
Tempo que a Verificação de Código levou para ser concluída, mostrado em horas, minutos e segundos.
Data de início/término
A data e a hora em que a Verificação de Código começou e terminou.
Problemas encontrados
Número de problemas encontrados em cada Nível de Severidade.
Log
Entradas de log do job de Verificação de Código. Use o log para revisar o status do job e quaisquer mensagens de erro.
Exemplo de log da Verificação de Código:
Resultados da Verificação de Código
Você pode ver os Resultados da Verificação de Código para ver em quais arquivos da sua branch a verificação encontrou problemas e quantos de cada Nível de Severidade foram encontrados.
Clique em Ver resultado.
No topo da página de resultados está o número total de problemas encontrados para cada Nível de Severidade. Abaixo dos totais há uma lista de arquivos de componentes com problemas, junto com um gráfico de barras dos problemas organizados por Severidade.
Resultados por arquivo
Os resultados por arquivo explicam a causa de cada problema e onde ele ocorre no arquivo-fonte. Revise cada problema e, quando aplicável, faça as alterações necessárias no componente.
Clique em um arquivo da lista para ver a lista completa de problemas.
Se disponível, clique em Mostrar mais para ver mais problemas encontrados neste arquivo.
A captura de tela e a tabela abaixo explicam as informações exibidas para cada problema.
Nível de severidade
Um círculo colorido com uma letra dentro indica o Nível de Severidade. A letra corresponde à primeira letra do nome do Nível de Severidade, e a cor corresponde ao nível. Observação: Major e Minor começam com M, mas Major é laranja e Minor é verde.
Nome da regra
O nome da regra que sinalizou o problema.
Descrição da violação
Uma descrição da causa do problema.
Local da violação
O número da linha e da coluna onde o problema foi encontrado.
Atualizado
Isto foi útil?