totvsengpro/advpl-tlpp-code-analyzer repository overview

⁠ADVPL/TLPP Code Analyzer

Projeto para criação de um container para análise de fontes .PRW e .PRX voltado para a execução local e principalmente, para execução em pipelines de CI/CD.

⁠Como Utilizar

Para iniciar a execução, basta amarrar um volume para a pasta /tmp com os arquivos a serem analisados:

docker run --rm -ti -v /path/to/files:/tmp totvsengpro/advpl-tlpp-code-analyzer

⁠Lista de regras do Sonar

Caso deseje consultar a lista e documentação dos códigos retornados pela análise, acesse: https://sonar-rules.engpro.totvs.com.br⁠

⁠Includes

Os arquivos de includes devem estar na pasta /tmp/includes, podendo ser passados junto com os arquivos no passo acima, através de uma pasta includes com os arquivos à serem analisados.

⁠Extração de JSON com resultados (opcional)

Para extrair um json com o resultado da execução, basta amarrar um volume para a pasta /bin/output

⁠Alterar configuração (opcional)

Para alterar as configurações, basta amarrar um volume para a pasta /bin/conf com um arquivo config.json seguindo o modelo com os valores padrão:

⁠config.json

{
    "breakList": [],
    "ignoreList": [],
    "breakOnError": true,
    "printSonarFullOutput": false,
    "printInternalWarnings": false
}

Opções:

• breakList: Lista de códigos de erro que serão apontados pelo analisador. Para pegar todos os erros, basta deixar a lista vazia.

• ignoreList: Lista de códigos de erro que serão ignorados caso apontados pelo analisador. Se um item estiver nessa lista, mesmo que dê erros, não irá influenciar no resultado da análise.

• breakOnError: Se estiver true, o analisador irá emitir um Exit Code de erro, possivelmente quebrando o pipeline. Colocando false, o Exit Code será de sucesso independentemente dos erros apontados.

• printSonarFullOutput: Se estiver true, além do resultado formatado, irá imprimir no console o json de saída da execução.

• printInternalWarnings: Se estiver true, warnings internos, principalmente do Java, serão exibidos caso existam.