ncc

ncc

Verificador de convenção de nomenclatura C/C++ (ncc)

ncc é uma ferramenta de desenvolvimento para ajudar os programadores a escrever código C/C++ que segue algumas convenções de nomenclatura. Ele automatiza o processo de verificação do código C/C++ para poupar os humanos dessa tarefa chata (mas importante). Isso o torna ideal para projetos que desejam impor um padrão de codificação.

Dependências

Os pacotes a seguir são pré-requisitos para a ferramenta ncc. Observe que o python 'clang' fornece ligações python libclang. A versão clang deve corresponder à versão libclang.so em seu sistema

• clangor
• yaml

 pip install clang
pip install pyyaml

Windows

No Microsoft Windows, instale a versão de 32 bits da cadeia de ferramentas do compilador LLVM.

Uso

 ncc . py [ - - help ] [ - - recurse ] [ - - style STYLE_FILE ] [ - - cdbdir CDBDIR ] [ - - dump ]
       [ - - output OUTPUT ] [ - - filetype FILETYPE ] [ - - exclude EXCLUDE [ EXCLUDE ...]]
       [ - - path PATH [ PATH ...]] [ - - include INCLUDE [ INCLUDE ...]]
       [ - - definition DEFINITION [ DEFINITION ...]] [ - - clang - lib CLANG_LIB ]

Para descrição detalhada de todas as opções:

 ncc . py - - help

Para imprimir todas as regras:

    ncc . py - - dump 

Definição de estilo

O estilo para construções c/c++ é definido por expressões regulares. Por exemplo, as regras abaixo dizem que uma estrutura pode ter qualquer caractere, um nome de classe deve começar com 'C' e uma variável de membro de classe deve começar com m_, e um nome de função deve começar com letras maiúsculas

    ClassName : ' C.* '
    CppMethod : ' [A-Z].* '
    VariableName :
        ScopePrefix :
            Global : ' g_ '
            Static : ' s_ '
            ClassMember : ' m_ '
        DataTypePrefix :
            String : ' str '
            Pointer : ' p '
            Integer : ' n '
            Bool : ' b '
        Pattern : ' ^.*$ ' 

Exemplo de uso

Verifique o arquivo test.cpp para violações da convenção de nomenclatura:

    ./ncc.py --style examples/ncc.style --path examples/test.cpp

    examples/test.cpp:16:7: " B " does not match " ^C.*$ " associated with ClassName
    examples/test.cpp:28:9: " b " does not match " ^m_.*$ " associated with ClassMemberVariable
    examples/test.cpp:31:5: " main(int, const char **) " does not match " ^[A-Z].*$ " associated with FunctionName
    Total number of errors = 3

Encontre recursivamente todos os arquivos no diretório 'exemplos', mas exclua os arquivos ' .cpp' e ' .h'

    ./ncc.py --style examples/ncc.style --recurse --exclude * .cpp * .h --path examples

    examples/test.hpp:4:7: " Test " does not match " ^C.*$ " associated with ClassName
    examples/test.hpp:12:9: " t " does not match " ^m_.*$ " associated with ClassMemberVariable
    examples/test.hpp:19:9: " _aaa " does not match " ^[a-z].*$ " associated with StructMemberVariable
    examples/test.c:8:9: " _b " does not match " ^[a-z].*$ " associated with StructMemberVariable
    examples/test.c:9:9: " _c " does not match " ^[a-z].*$ " associated with StructMemberVariable
    examples/tmp/test.hpp:4:7: " Test " does not match " ^C.*$ " associated with ClassName
    examples/tmp/test.hpp:12:9: " t " does not match " ^m_.*$ " associated with ClassMemberVariable
    examples/tmp/test.hpp:19:9: " _aaa " does not match " ^[a-z].*$ " associated with StructMemberVariable
    Total number of errors = 8

Licença

Direitos autorais © 2018 Nithin Nellikunnu

Distribuído sob a licença MIT (MIT).

Obrigado

Daniel J. Hofmann