cmake tidy

cmake-tidy

Inhaltsverzeichnis

• 1. Einführung
• 2. Anwendungsnutzung
  • 2.1. format -Unterbefehl
  • 2.2. Unterbefehle analyze
• 3. Bekannte Einschränkungen/Fehler
• 4. Andere Informationen
  • 4.1. Installation
  • 4.2. CI -Status

1. Einführung

Ziel des Projekts ist es, eine Reihe von Tools bereitzustellen, die den Entwicklungsprozess für den in CMake geschriebenen Build -Systemcode erleichtern. Hauptideen des Tools sind aber nicht beschränkt auf:

• CMake -Code -Formatierung - basierend auf der Sprachsyntaxanalyse

• Moderne CMake -statische Analyse - Grundlegende Codeanalyse mit einer möglichen automatischen Fixierung.

• Große Flexibilität der Konfiguration - Da sich die Codierungsstile sehr stark unterscheiden.

• Einfach zu bedienen-Nachahmung und Parameter mit anderen hochmodernen Tools zur Reduzierung der Lernkurve für Benutzer.

2. Anwendungsnutzung

cmake-tidy ist eine in python3 geschriebene Befehlszeilenanwendung.

Verfügbare Unterbefehle:

 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. format -Unterbefehl

2.1.1. Verwendung

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

Der Benutzer kann eine alternative Einstellungen für eine Anwendung bereitstellen, indem sie benutzerdefinierte .cmake-tidy.json -Datei bereitstellen. Weitere Informationen zu verfügbaren Parametern und Werten finden Sie hier .

2.2. Unterbefehle analyze

Die Einführung dauert an.

3. Bekannte Einschränkungen/Fehler

• Die Anwendung kann nur gültige CMake -Dateien formatieren (Syntaxfehler bewirken, dass die Anwendung beendet wird, ohne den Inhalt der formatierten Datei zu ändern).

• Unterstützung für deprecated Keywords/Eigenschaften für ältere Versionen von CMake als angegeben im Befehl --version könnte begrenzt sein. Wenn Sie sie unterstützen müssen, geben Sie diese bitte als benutzerdefinierte Schlüsselwörter in .cmake-tidy.json -Konfigurationsdatei an oder geben Sie sie als benutzerdefinierte Schlüsselwörter an.

• Line Continuation Handhabung wird nicht implementiert.

4. Andere Informationen

4.1. Installation

Das Tool ist über den Python -Paketindex mit dem Befehl erhältlich:

python3 -m pip install cmake-tidy

Um die Installation erfolgreich zu sein, können Sie ausführen:

cmake-tidy -v

4.2. CI -Status

Automatische Tests erfolgen mit Workflows:

• ubuntu-lastest, python-3.8

• windows-lastest, python-3.8