cmake tidy Download - cmake tidy Code Téléchargement

cmake tidy

Autres catégories

Official beta release

Télécharger

cmake-tidy

Table des matières

1. Introduction
2. Utilisation des applications
- 2.1. sous-commande format
- 2.2. analyze la sous-commande
3. Limites / bogues connus
4. Autres informations
- 4.1. Installation
- 4.2. Statut de CI

1. Introduction

L'objectif du projet est de fournir un ensemble d'outils qui faciliteront le processus de développement du code des systèmes de construction écrits dans CMake . Les principales idées de l'outil sont sans s'y limiter:

Formatage du code CMake - basé sur l'analyse de la syntaxe linguistique
Analyse statique CMake moderne - Analyse de code de base avec une éventuelle fixation automatique.
Une grande flexibilité de la configuration - car les styles de codage diffèrent beaucoup.
Facile à utiliser - Mimic Utilisation et paramètres avec d'autres outils de pointe pour réduire la courbe d'apprentissage pour les utilisateurs.

2. Utilisation des applications

cmake-tidy est une application de ligne de commande écrite dans python3 .

Sous-commandes 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. sous-commande `format`

2.1.1. Usage

 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. Configuration

L'utilisateur peut fournir des paramètres alternatifs à une application en fournissant un fichier .cmake-tidy.json personnalisé. Pour plus d'informations sur les paramètres et les valeurs disponibles, visitez ici .

2.2. `analyze` la sous-commande

L'introduction est en cours.

3. Limites / bogues connus

L'application peut formater uniquement les fichiers CMake valides (les erreurs de syntaxe provoquent la sortie de l'application sans modifier le contenu du fichier formaté).
La prise en charge des mots clés / propriétés deprecated pour la version ancienne de CMake que spécifiée dans la commande --version pourrait être limité. Si vous devez les prendre en charge, veuillez fournir une demande Pull ou les spécifier en tant que mots clés personnalisés dans le fichier de configuration .cmake-tidy.json .
La gestion la continuation de ligne n'est pas mise en œuvre.