cmake tidy

cmake-tidy

Tabla de contenido

• 1. Introducción
• 2. Uso de la aplicación
  • 2.1. Subcomando format
  • 2.2. analyze subcomando
• 3. Limitaciones/errores conocidos
• 4. Otra información
  • 4.1. Instalación
  • 4.2. Estado de CI

1. Introducción

El objetivo del proyecto es proporcionar un conjunto de herramientas que alivien el proceso de desarrollo para el código de sistemas de compilación escrito en CMake . Las ideas principales de la herramienta no se limitan a:

• Formato de código CMake : basado en el análisis de sintaxis del lenguaje

• Análisis estático CMake moderno: análisis de código básico con posible fijación automática.

• Gran flexibilidad de la configuración: ya que los estilos de codificación difieren bastante.

• Fácil de usar: el uso y los parámetros de imitación con otras herramientas de última generación para reducir la curva de aprendizaje para los usuarios.

2. Uso de la aplicación

cmake-tidy es una aplicación de línea de comandos escrita en python3 .

Subcomands disponibles:

 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. Configuración

El usuario puede proporcionar configuraciones alternativas a una aplicación al proporcionar el archivo .cmake-tidy.json personalizado. Para obtener más información sobre los parámetros y valores disponibles, visite aquí .

2.2. analyze subcomando

La introducción está en curso.

3. Limitaciones/errores conocidos

• La aplicación puede formatear solo archivos CMake válidos (los errores de sintaxis hacen que la aplicación salga sin modificar el contenido del archivo formateado).

• El soporte para palabras clave/propiedades deprecated para la versión anterior de CMake que el comando especificado en --version podría ser limitado. Si necesita admitirlos, proporcione una solicitud de extracción o las especifique como palabras clave personalizadas en el archivo de configuración .cmake-tidy.json .

• Continuación de línea Manejo no se implementa.

4. Otra información

4.1. Instalación

La herramienta está disponible a través del índice de paquetes de Python usando el comando:

python3 -m pip install cmake-tidy

Para confirmar que la instalación fue exitosa, puede ejecutar:

cmake-tidy -v

4.2. Estado de CI

Las pruebas automatizadas se realizan con flujos de trabajo:

• ubuntu-lastest, python-3.8

• windows-lastest, python-3.8