O Nimalyzer é um analisador de código estático para a linguagem de programação NIM. Ele permite verificar um código -fonte NIM em relação às regras predefinidas. Seu design é inspirado no Adacontrol. O Nimalyzer pode ser usado para aplicar alguns padrões de design ou garantir que algumas construções de idiomas estejam presentes em um código, ou não. Por exemplo, ele pode verificar se todos os procedimentos definiram pragmas adequados. Além disso, ele pode ser usado como uma pesquisa avançada através de uma ferramenta de código, por exemplo, encontre todas as variáveis públicas tipo de int com o nome que começa com o Newvar . É controlado por arquivos de configuração que contêm um conjunto de regras, seus parâmetros e opções relacionadas ao comportamento do programa.
Nesse momento, o projeto está no estágio beta , a maioria de seus recursos é adicionada, mas ainda deve ter uma boa quantidade de bugs.
Se você ler este arquivo no github: Não envie solicitações de puxar aqui . Tudo será fechado automaticamente. Quaisquer proposições de código devem ir para o repositório fóssil.
IMPORTANTE: Se você ler o arquivo no repositório de código do projeto: esta versão do arquivo está relacionada à versão futura do programa. Pode conter informações não presentes nas versões liberadas do programa. Para essas informações, consulte o arquivo readme.md incluído na versão.
Para usar o Nimalyzer com seu projeto, primeiro você deve criar um arquivo de configuração para ele. Para a sintaxe do arquivo de configuração e a lista de regras disponíveis, consulte a documentação do projeto, disponível como reestruturada Text no diretório DOC. No seu arquivo de configuração, você precisará definir pelo menos um arquivo de origem para verificar e pelo menos uma regra para usar.
Execute o Nimanalyzer com o caminho para o seu arquivo de configuração como o argumento. Por exemplo: nimalyzer config/nimalyzer.cfg e acabei de ler sua saída. ;)
Os binários independentes estão disponíveis para FreeBSD, Linux e Windows em versões de 64 bits. Eles estão disponíveis na página de download. Basta baixar e extraí -los para o diretório selecionado.
Você precisará:
Você pode instalá -los manualmente ou usando o Nimble. Nessa segunda opção, digite nimble install nimalyzer para instalar o programa e todas as dependências. Geralmente, é recomendável usar nimble release para criar o projeto no modo de liberação (otimizado) ou nimble debug para construí -lo no modo de depuração.
Para criar a versão HTML do comando de documentação do projeto Run Command nimble docs no diretório principal do projeto.
Se você deseja atualizar a documentação do projeto, geralmente não é necessário, você deve usar a ferramenta Gendoc incluída no projeto.
Construa a ferramenta Gendoc . No diretório principal do projeto, execute nimble tools Command. Ele criará as ferramentas necessárias e as colocará no diretório de bin .
No diretório do projeto do Man bin/gendoc . Ele atualizará a documentação do projeto a partir do arquivo de configuração padrão e do código -fonte do projeto.
O projeto divulgado sob a licença BSD de 3 cláusulas.
Isso é tudo por enquanto, como sempre, provavelmente esqueci de algo importante;)
Bartek Thindil Jasicki