qmlformat

qmlformat

qmlformat est un outil qui formate automatiquement les fichiers QML conformément aux conventions de codage QML. Plus d'informations...

Utilisation :
qmlformat[options] arguments

Options

Les options suivantes sont disponibles :

OptionValeur par défautDescription
-h, --helpAffiche l'aide sur les options de la ligne de commande.
--help-allAffiche l'aide, y compris les options génériques de Qt.
-v, --versionAffiche des informations sur la version.
-V, --verboseMode verbeux. Affiche des informations plus détaillées.
--write-defaultsÉcrit les paramètres par défaut dans le fichier .qmlformat.ini et quitte (Attention : Cela écrasera tous les paramètres et commentaires existants !)
--ignore-settingsIgnore tous les fichiers de configuration et ne prend en compte que les options de la ligne de commande
-i, --inplaceModifie le fichier sur place au lieu de l'afficher sur la sortie standard.
-f, --forceContinue même si une erreur s'est produite.
-t, --tabsUtiliser des tabulations au lieu d'espaces.
-w, --indent-width <width>4Combien d'espaces sont utilisés lors de l'indentation.
-W, --column-width <width>-1Coupe la ligne en plusieurs lignes si elle dépasse la largeur spécifiée. Utilisez -1 pour désactiver le retour à la ligne. (par défaut).
-n, --normalizeRéorganise les attributs des objets conformément aux directives de codage QML.
-F, --files <file>Formate tous les fichiers listés dans file, in-place
-l, --newline <newline>Remplacer le nouveau format de ligne à utiliser (natif macos unix windows).
-S, --sort-importsTrier les importations par ordre alphabétique (Attention : cela peut changer la sémantique si un nom donné identifie des types dans plusieurs modules !)
--objects-spacingAssurer les espaces entre les objets (ne fonctionne qu'avec l'option normaliser).
--functions-spacingAssurer les espaces entre les fonctions (ne fonctionne qu'avec l'option normalize).
--semicolon-ruletoujoursPersonnalise l'ajout de points-virgules à la fin des déclarations JS.

Arguments

Arguments :
noms de fichiers

Détails

qmlformat est flexible et peut être configuré selon vos besoins.

Sortie

qmlformat écrit la version formatée du fichier sur stdout. Si vous souhaitez que votre fichier soit mis à jour sur place, spécifiez le drapeau -i.

Regroupement des propriétés, des fonctions et des signaux

Avec l'option -n ou --normalize, qmlformat regroupe toutes les propriétés, fonctions et signaux ensemble, au lieu de conserver l'ordre que vous avez spécifié.

Fichier de paramètres

Vous pouvez configurer qmlformat en incluant un fichier de configuration .qmlformat.ini dans les sources de votre projet ou dans les répertoires parents du dossier des sources de votre projet. Un fichier de configuration par défaut peut être obtenu en passant l'option --write-defaults. Cela génère le fichier .qmlformat.ini dans le répertoire de travail actuel.

Attention : --write-defaults écrasera tous les paramètres et commentaires existants !

Les paramètres suivants sont disponibles dans le fichier .qmlformat.ini:

ParamètreValeur par défautValeur par défaut Description
UseTabsfauxUtilise les tabulations au lieu des espaces.
Largeur d'indentation4Nombre d'espaces utilisés lors de la mise en retrait.
Type de nouvelle lignenatifRemplace le format de nouvelle ligne à utiliser (native, macos, unix, windows).
NormalizeOrderfauxRéorganise les attributs des objets conformément aux directives de codage QML.
FonctionsEspacementfalseAssure des espaces entre les fonctions (ne fonctionne qu'avec l'option normalize).
Espacement des objetsfauxAssure l'espacement entre les objets (ne fonctionne qu'avec l'option de normalisation).
MaxColumnWidth-1Coupe la ligne en plusieurs lignes si elle dépasse la largeur spécifiée. Utilisez -1 pour désactiver le retour à la ligne (par défaut).
SortImportsfauxTrie les importations par ordre alphabétique.

Remarque : cela peut modifier la sémantique si un nom donné identifie des types dans plusieurs modules.

Règle du point-virguletoujoursPersonnalise l'ajout de points-virgules à la fin des déclarations JS (always, essential).

Note : Voir la règle du point-virgule pour plus de détails.

Formatage d'une liste de fichiers

Bien que vous puissiez passer une liste de fichiers à formater comme arguments, qmlformat propose l'option -F pour formater un ensemble de fichiers stockés dans un fichier. Dans ce cas, le formatage se fera sur place.

// FileList.txt
main.qml
mycomponent.qml

Il suffit alors de l'utiliser comme

qmlformat -F FileList.txt

Note : Si le fichier contient une entrée invalide, par exemple, un chemin de fichier qui n'existe pas ou un chemin de fichier valide mais le contenu est un document qml invalide, alors qmlformat se trompera pour cette entrée particulière. Il continuera à formater les entrées valides du fichier en place.

Attention : Si vous fournissez l'option -F, qmlformat ignorera les arguments de position.

Règle du point-virgule

L'option --semicolon-rule vous permet de personnaliser l'ajout de points-virgules à la fin des déclarations JS. Les valeurs suivantes sont acceptées :

  • always - Toujours ajouter des points-virgules (valeur par défaut).
  • essential - Supprimer les points-virgules à moins que leur omission ne cause des problèmes.

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