qmlformat
qmlformat
qmlformatはQMLファイルをQMLコーディング規約に従って自動的にフォーマットするツールです。詳細...
オプション
以下のオプションが利用できる：
| オプション | デフォルト値 | 説明 |
|---|---|---|
| -h, -help | コマンドラインオプションのヘルプを表示する。 | |
| -help-all | 一般的な Qt オプションを含むヘルプを表示します。 | |
| -v, -version | バージョン情報を表示します。 | |
| -V, -verbose | 冗長モード。より詳細な情報を出力します。 | |
| -write-defaults | デフォルトの設定を .qmlformat.ini に書き込んで終了する (警告: 既存の設定やコメントは上書きされます!)。 | |
| -無視設定 | すべての設定ファイルを無視し、コマンドラインオプションのみを考慮します。 | |
| -i, -inplace | 標準出力に出力する代わりに、ファイルをインプレースで編集します。 | |
| -f, -force | エラーが発生しても続行する。 | |
| -t, -tabs | スペースの代わりにタブを使う。 | |
| -w, -インデント幅 <width | 4 | インデント時に使用するスペース数を指定する。 |
| -n, -normalize | QML Coding Guidelinesに従ってオブジェクトの属性を並べ替える。 | |
| -F, -files <ファイル | fileにリストされているすべてのファイルをインプレースで整形する。 | |
| -l, -newline <改行 | 使用する改行フォーマットをオーバーライドする(ネイティブ macos unix windows)。 | |
| -objects-spacing | オブジェクト間のスペースを確保する（normalizeオプションでのみ動作）。 | |
| -functions-spacing | 関数間のスペースを確保する（normalizeオプションでのみ動作）。 |
引数
| 引数を指定します： |
|---|
| ファイル名 |
詳細
qmlformatは柔軟で、必要に応じて設定することができる。
出力
qmlformat はフォーマットされたファイルを標準出力に書き出します。ファイルをインプレースで更新したい場合は-i フラグを指定してください。
プロパティ、関数、シグナルのグループ化
-n または--normalize フラグを指定すると、qmlformat はすべてのプロパティ、関数、シグナルをグループ化します。
設定ファイル
設定ファイル.qmlformat.ini をプロジェクトソースかプロジェクトソースフォルダの親ディレクトリに含めることで、qmlformatを設定することができます。デフォルトの設定ファイルは--write-defaults フラグを渡すことで取得できます。これにより、現在の作業ディレクトリに.qmlformat.ini ファイルが生成されます。
警告： --write-defaults は既存の設定やコメントを上書きします！
.qmlformat.ini ファイルでは以下の設定が可能です：
| 設定 | デフォルト値 | 説明 |
|---|---|---|
| タブ使用 | 偽 | スペースの代わりにタブを使う。 |
| インデント幅 | 4 | インデント時に使用する空白の数。 |
| 改行タイプ | ネイティブ | 使用する改行書式を上書きする (native,macos,unix,windows)。 |
| 正規化順序 | false | QML コーディングガイドラインに従ってオブジェクトの属性を並べ替えます。 |
| FunctionsSpacing | false | 関数間のスペースを確保します（normalize オプションでのみ機能します）。 |
| オブジェクトの間隔 | false | オブジェクト間のスペースを確保する（normalizeオプションでのみ動作）。 |
ファイルリストのフォーマット
フォーマットしたいファイルのリストを引数として渡すこともできますが、 qmlformat は-F オプションを提供しており、 ファイルに格納されたファイル群をフォーマットすることができます。この場合、フォーマットはインプレースで行われます。
// FileList.txt main.qml mycomponent.qml
そして、次のように使います。
qmlformat -F FileList.txt
注: ファイルに無効なエントリーが含まれている場合、例えば存在しないファイルパスや、有効なファイルパスであっても内容が無効なqmlドキュメントである場合、qmlformat 、その特定のエントリーはエラーになります。有効なファイルエントリーはそのままフォーマットされます。
警告 Fオプションを指定すると、qmlformatは位置引数を無視します。
© 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.
