haxe checkstyle

O Haxe Checkstyle é uma ferramenta de análise estática para ajudar os desenvolvedores a escrever o código HAXE que adere a um padrão de codificação.

Ele automatiza o processo de verificar o código HAXE para poupar desenvolvedores desta tarefa chata (mas importante).

As convenções de código melhoram a legibilidade, permitindo que os membros da equipe entendam melhor o código um do outro.

Ideal para qualquer projeto que deseje aplicar convenções de codificação.

A análise estática geralmente é realizada como parte de uma revisão de código.

Código clima

O Haxe Checkstyle está disponível na plataforma climática de código (gratuita para projetos de código aberto). Requer um arquivo .codeclimate.yml e um arquivo de checkstyle.json opcional, mas recomendado, a ser adicionado à raiz do seu repositório - veja aqui para obter mais detalhes.

Quando tudo estiver configurado, o Code Climate executa automaticamente o estilo de seleção Haxe para você em cada novo comprometimento (também em solicitações de tração se configurado dessa maneira).

O número atual de problemas pode ser rastreado por meio de um crachá:

Resultados imediatos, certo em suas solicitações de tração.

Instalação

haxelib install checkstyle

Uso básico

haxelib run checkstyle -s src

Detecção automática do seu estilo de codificação (experimental)

haxelib run checkstyle -s src --detect detectedCheckstyle.json

Integração do vscode

Existe uma extensão do VSCODE para Haxe-checkstyle disponível no mercado do VSCode. Atualmente, é construído com o Haxe-checkstyle v2.4.1 e o tokentree v1.0.1. Você pode ver a versão de desenvolvimento aqui: vscode-checkstyle

Compilando o estilo de seleção

git clone https://github.com/HaxeCheckstyle/haxe-checkstyle.git
npm install
lix download
haxe buildAll.hxml # for Neko and NodeJS version + run Unittests and create schema
haxe buildCpp.hxml # for C++ version

Compilando com haxe 3

git clone https://github.com/HaxeCheckstyle/haxe-checkstyle.git
mv haxe_libraries haxe4_libraries
mv haxe3_libraries haxe_libraries
npm install
lix use haxe 3.4.7
lix download
haxe buildAll.hxml # for Neko and NodeJS version + run Unittests and create schema
haxe buildCpp.hxml # for C++ version

Referência

Mais informações e referência.

Problemas

Encontrou algum bug? Por favor, crie um novo problema.

Cobertura

Informações de licenciamento

Este conteúdo é liberado sob a licença do MIT.

Este projeto foi derivado de Haxelint criado por @mcheshkov.

Código de Conduta Colaborador

O Código de Conduta é adaptado da Aliança Colaboradora, versão 1.4