Download do cmake tidy - cmake tidy Download de código fonte

cmake tidy

Outras categorias

Official beta release

Baixar

cmake-tidy

Índice

1. Introdução
2. Uso do aplicativo
- 2.1. Subcomando format
- 2.2. analyze o subcomando
3. Limitações/bugs conhecidos
4. Outras informações
- 4.1. Instalação
- 4.2. Status do CI

1. Introdução

O objetivo do projeto é fornecer um conjunto de ferramentas que aliviarão o processo de desenvolvimento para o código de sistemas de construção escrito no CMake . As principais idéias da ferramenta não se limitam a:

Formatação de código CMake - Com base na análise de sintaxe da linguagem
Análise estática moderna CMake - Análise básica de código com possível fixação automática.
Grande flexibilidade de configuração - como os estilos de codificação diferem bastante.
Fácil de usar-imitação e parâmetros imitados com outras ferramentas de ponta para reduzir a curva de aprendizado para os usuários.

2. Uso do aplicativo

cmake-tidy é um aplicativo de linha de comando escrito no python3 .

Subcomando disponíveis:

 usage: cmake-tidy [-h] {format} ...

optional arguments:
  -h, --help  show this help message and exit

sub-commands:
  {format}    see "cmake-tidy <command> --help" to read more about a specific
              sub-command.
    format    format file to align it to standard

2.1. Subcomando `format`

2.1.1. Uso

 usage: cmake-tidy format [-h] [--dump-config] [-i] [--diff] [--verbose]
                         [input [input ...]]

positional arguments:
  input          CMake file to be formatted

optional arguments:
  -h, --help     show this help message and exit
  --dump-config  Dump to stdout current settings. Script tries to read
                 settings from `.cmake-tidy.json` or provides default
                 settings. Precedence of searching `.cmake-tidy.json` is
                 described on github
  -i, --inplace  Inplace edit specified <input_data> file
  --diff         Print to stdout unified diff between original file and
                 formatted version.
  --verbose      Print to stdout information about formatted file

2.1.2. Configuração

O usuário pode fornecer configurações alternativas para um aplicativo, fornecendo arquivo personalizado .cmake-tidy.json . Para obter mais informações sobre os parâmetros e valores disponíveis, visite aqui .

2.2. `analyze` o subcomando

A introdução está em andamento.

3. Limitações/bugs conhecidos

O aplicativo pode formatar apenas arquivos cmake válidos (erros de sintaxe fazem com que o aplicativo saia sem modificar o conteúdo do arquivo formatado).
Suporte para palavras -chave/propriedades deprecated para a versão mais antiga do cmake do que o especificado no comando --version pode ser limitado. Se você precisar apoiá-los, forneça solicitação de puxar ou especifique-os como palavras-chave personalizadas no arquivo de configuração .cmake-tidy.json .
Continuação de linhas manipulação não é implementada.