PYSIDE6-QMLFORMAT(1)

πŸ“¦
version 6.11.2 Β· 2 versions
, in ubuntu stonking

πŸ’– PYSIDE6-QMLFORMAT πŸ’–

okay bestie, welcome to pyside6-qmlformat β€” that's the tool from the PySide6 tools collection, and yes she is literally just qmlformat with a glow-up. she's here to make your QML files look as good as you do. πŸ’…


✨ NAME ✨

pyside6-qmlformat β€” aka qmlformat. same girl, different outfit. πŸŽ€


🌸 SYNOPSIS 🌸

qmlformat [options] filenames

πŸ¦‹ DESCRIPTION πŸ¦‹

so what does she do? she formats your QML files according to the QML Coding Conventions. no cap, that's the whole job, and she eats every time. πŸ”₯

little insider info for you: every option sitting below the "Formatting options" section can also be set through .qmlformat.ini β€” unless you pass --ignore-settings, in which case the ini file gets ghosted entirely. πŸ™ˆ


πŸ‘‘ OPTIONS πŸ‘‘

  • -h, --help β€” shows you the help for the command line options. your girl explains herself. πŸ’–
  • --help-all β€” same help energy, but it also throws in all the generic Qt options. the deluxe version. ✨
  • -v, --version β€” spits out the version info.
  • -V, --verbose β€” verbose mode. she tells you everything, in detail, no holding back. πŸ—£οΈ
  • --write-defaults β€” writes the default settings to .qmlformat.ini and then dips. (Warning: this will overwrite any existing settings and comments! like, gone-gone. 😭)
  • --output-options β€” outputs all the available options and their default values in JSON format. organized queen. πŸ“
  • --ignore-settings β€” ignores all settings files and only considers the command line options you gave her. nothing else gets a vote. πŸ’€
  • -F, --files <file> β€” formats every file listed inside file, in-place. batch mode, we love to see it.
  • --dry-run β€” prints the settings file that would be used for this instance. This is useful to see what settings would be used without actually performing anything. she's just showing you the fit before wearing it. 🫢
  • -s, --settings <file> β€” use the specified .qmlformat.ini file as the only configuration source. Overrides any per-directory configuration lookup. one source of truth, periodt.
  • -i, --inplace β€” edits the file in-place instead of outputting to stdout.

πŸ’… Formatting options πŸ’…

  • -t, --tabs β€” use tabs instead of spaces. team tabs, rise up. 🌈
  • -w, --indent-width <width> β€” how many spaces are used when indenting.
  • -W, --column-width <width> β€” breaks the line into multiple lines if it exceedes the specified width. Use -1 to disable line wrapping. (that's the default btw)
  • -n, --normalize β€” reorders and sorts the attributes of the objects according to the QML Coding Guidelines. Incompatible with --group-attributes-together. pick a lane bestie, you can't have both. 🚫
  • -l, --newline <newline> β€” override the new line format to use (native, macos, unix, windows).
  • --objects-spacing β€” ensure spaces between objects (only works with normalize or group-attributes-together option).
  • --functions-spacing β€” ensure spaces between functions (only works with normalize or group-attributes-together option).
  • --group-attributes-together β€” reorders but does not sort the attributes of the objects according to the QML Coding Guidelines. Incompatible with --normalize. (again: one or the other, never both πŸ’€)
  • -S, --sort-imports β€” sorts imports alphabetically. (Warning: this might change semantics if a given name identifies types in multiple modules!) so like… she's iconic but she can also ruin your life. proceed with caution. ⚠️
  • --single-line-empty-objects β€” write empty objects on a single line (only works with normalize or group-attributes-together option).
  • --semicolon-rule <rule> β€” specify the semicolon rule to use (always, essential). always: always adds semicolon [default]. essential: adds only when ASI wouldn't be relied on.

🌟 Arguments: 🌟

  • filenames β€” files to be processed by qmlformat. hand her your files, she handles the rest. πŸ’–

fr fr, that's the whole thing. now go forth and let her format your QML, you're gonna look so put together. 😌✨

mwah πŸ’‹ β€” this has been pyside6-qmlformat version 6.11, brought to you by PySide6 tools, dated September 2026. she's booked, she's busy, she's formatting. periodt. πŸ‘‘

πŸ“¦ where this page comes from