qmlformat is a tool that automatically formats QML files in accordance with the QML Coding Conventions. More...

qmlformat [options] arguments


The following options are available:

OptionDefault ValueDescription
-h, –helpDisplays help on commandline options.
–help-allDisplays help, including generic Qt options.
-v, –versionDisplays version information.
-V, –verboseVerbose mode. Outputs more detailed information.
–write-defaultsWrites defaults settings to .qmlformat.ini and exits (Warning: This will overwrite any existing settings and comments!)
–ignore-settingsIgnores all settings files and only takes command line options into consideration
-i, –inplaceEdit file in-place instead of outputting to stdout.
-f, –forceContinue even if an error has occurred.
-t, –tabsUse tabs instead of spaces.
-w, –indent-width <width>4How many spaces are used when indenting.
-n, –normalizeReorders the attributes of the objects according to the QML Coding Guidelines.
-F, –files <file>Format all files listed in file, in-place
-l, –newline <newline>Override the new line format to use (native macos unix windows).
–objects-spacingEnsure spaces between objects (only works with normalize option).
–functions-spacingEnsure spaces between functions (only works with normalize option).




qmlformat is flexible and can be configured according to your needs.


qmlformat writes the formatted version of the file to stdout. If you wish to have your file updated in-place specify the -i flag.

Grouping Properties, Functions, and Signals Together

With -n or --normalize flag, qmlformat groups all properties, functions, and signals together, instead of retaining the order you specified.

Settings File

You can configure qmlformat by including a settings file .qmlformat.ini in your project source or in the parent directories of your project source folder. A default settings file can be obtained by passing the --write-defaults flag. This generates the .qmlformat.ini file in the current working directory.

Warning: --write-defaults will overwrite any existing settings and comments!

Formatting a List of Files

While you can pass a list of files to be formatted as arguments, qmlformat provides -F option to format a set of files stored in a file. In this case, formatting will happen inplace.

// FileList.txt

Then, use it like

qmlformat -F FileList.txt

Note: If the file contains an invalid entry, for example, a file path that doesn't exist or a valid file path but the content is an invalid qml document, then qmlformat will error out for that particular entry. It will still format the valid file entries in place.

Warning: If you provide -F option, qmlformat will ignore the positional arguments.

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