qmlformat
qmlformat
qmlformat ist ein Werkzeug, das QML-Dateien automatisch in Übereinstimmung mit den QML Coding Conventions formatiert. Mehr...
Optionen
Die folgenden Optionen sind verfügbar:
| Option | Standardwert | Beschreibung |
|---|---|---|
-h, --help | Zeigt Hilfe zu Kommandozeilenoptionen an. | |
--help-all | Zeigt Hilfe an, einschließlich allgemeiner Qt-Optionen. | |
-v, --version | Zeigt Versionsinformationen an. | |
-V, --verbose | Ausführlicher Modus. Gibt detailliertere Informationen aus. | |
--write-defaults | Schreibt die Standardeinstellungen in die Datei .qmlformat.ini und beendet sich (Achtung: Dies überschreibt alle vorhandenen Einstellungen und Kommentare!) | |
--ignore-settings | Ignoriert alle Einstellungsdateien und berücksichtigt nur die Kommandozeilenoptionen | |
-i, --inplace | Editiert die Datei an Ort und Stelle, anstatt sie auf stdout auszugeben. | |
-f, --force | Fortfahren, auch wenn ein Fehler aufgetreten ist. | |
-t, --tabs | Tabulatoren anstelle von Leerzeichen verwenden. | |
-w, --indent-width <width> | 4 | Wie viele Leerzeichen werden beim Einrücken verwendet. |
-W, --column-width <width> | -1 | Bricht die Zeile in mehrere Zeilen um, wenn sie die angegebene Breite überschreitet. Verwenden Sie -1, um den Zeilenumbruch zu deaktivieren. (Voreinstellung). |
-n, --normalize | Ordnet die Attribute der Objekte gemäß den QML-Codierrichtlinien neu an. | |
-F, --files <file> | Formatiert alle in der Datei aufgelisteten Dateien, in-place | |
-l, --newline <newline> | Überschreiben des zu verwendenden neuen Zeilenformats (nativ macos unix windows). | |
-S, --sort-imports | Importe alphabetisch sortieren (Achtung: dies kann die Semantik verändern, wenn ein bestimmter Name Typen in mehreren Modulen identifiziert!) | |
--objects-spacing | Leerzeichen zwischen Objekten sicherstellen (funktioniert nur mit der Option normalize). | |
--functions-spacing | Leerzeichen zwischen Funktionen sicherstellen (funktioniert nur mit der Option normalize). | |
--semicolon-rule | immer | Das Hinzufügen von Semikolons am Ende von JS-Anweisungen anpassen. |
Argumente
| Argumente: |
|---|
| Dateinamen |
Einzelheiten
qmlformat ist flexibel und kann nach Ihren Bedürfnissen konfiguriert werden.
Ausgabe
qmlformat schreibt die formatierte Version der Datei auf stdout. Wenn Sie möchten, dass Ihre Datei an Ort und Stelle aktualisiert wird, geben Sie das Flag -i an.
Gruppierung von Eigenschaften, Funktionen und Signalen
Mit dem Flag -n oder --normalize gruppiert qmlformat alle Eigenschaften, Funktionen und Signale zusammen, anstatt die von Ihnen angegebene Reihenfolge beizubehalten.
Einstellungsdatei
Sie können qmlformat konfigurieren, indem Sie eine Einstellungsdatei .qmlformat.ini in Ihren Projektquelltext oder in die übergeordneten Verzeichnisse Ihres Projektquelltextordners einfügen. Eine Standard-Einstellungsdatei kann durch die Übergabe des Flags --write-defaults erhalten werden. Dies erzeugt die Datei .qmlformat.ini im aktuellen Arbeitsverzeichnis.
Achtung: --write-defaults überschreibt alle vorhandenen Einstellungen und Kommentare!
Die folgenden Einstellungen sind in der Datei .qmlformat.ini verfügbar:
| Einstellung | Standardwert | Beschreibung |
|---|---|---|
| UseTabs | false | Verwendet Tabulatoren anstelle von Leerzeichen. |
| Einzugsbreite | 4 | Wie viele Leerzeichen beim Einrücken verwendet werden. |
| ZeilenumbruchTyp | nativ | Setzt das zu verwendende Zeilenumbruchformat außer Kraft (native, macos, unix, windows). |
| NormalizeOrder | false | Ordnet die Attribute der Objekte gemäß den QML-Codierrichtlinien neu an. |
| FunktionenAbstand | false | Sorgt für Abstände zwischen den Funktionen (funktioniert nur mit der Option normalize). |
| ObjekteAbstand | false | Sorgt für Abstände zwischen den Objekten (funktioniert nur mit der Option normalize). |
| MaxColumnWidth | -1 | Bricht die Zeile in mehrere Zeilen um, wenn sie die angegebene Breite überschreitet. Verwenden Sie -1, um den Zeilenumbruch zu deaktivieren (Standard). |
| SortierenImportieren | false | Sortiert Importe alphabetisch. Hinweis: Dies kann die Semantik verändern, wenn ein bestimmter Name Typen in mehreren Modulen identifiziert. |
| SemikolonRegel | immer | Passt das Hinzufügen von Semikolons am Ende von JS-Anweisungen an (always, essential).Hinweis: Siehe Semikolon-Regel für weitere Einzelheiten. |
Formatierung einer Liste von Dateien
Während Sie eine Liste von Dateien, die formatiert werden sollen, als Argumente übergeben können, bietet qmlformat mit -F die Möglichkeit, einen Satz von Dateien zu formatieren, die in einer Datei gespeichert sind. In diesem Fall wird die Formatierung an Ort und Stelle durchgeführt.
// FileList.txt main.qml mycomponent.qml
Dann verwenden Sie es wie
qmlformat -F FileList.txt
Hinweis: Wenn die Datei einen ungültigen Eintrag enthält, z. B. einen Dateipfad, der nicht existiert, oder einen gültigen Dateipfad, aber der Inhalt ist ein ungültiges qml-Dokument, dann wird qmlformat für diesen bestimmten Eintrag einen Fehler anzeigen. Die gültigen Dateieinträge werden jedoch weiterhin formatiert.
Warnung: Wenn Sie die Option -F angeben, ignoriert qmlformat die Positionsargumente.
Semikolon-Regel
Mit der Option --semicolon-rule können Sie das Hinzufügen von Semikolons am Ende von JS-Anweisungen anpassen. Die folgenden Werte werden akzeptiert:
always- Immer Semikolons hinzufügen (Standard).essential- Entfernen Sie Semikolons, es sei denn, ihr Weglassen würde Probleme verursachen.
© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
