qmlformat

qmlformat

qmlformat 是一个工具,可以自动按 QML 编码约定 格式化 QML 文件。 更多信息...

用法
qmlformat [选项] 参数

选项

以下选项可用

选项默认值描述
-h, –help显示命令行选项的帮助信息。
–help-all显示帮助信息,包括通用的 Qt 选项。
-v, –version显示版本信息。
-V, –verbose详细模式。输出更详细的信息。
–write-defaults将默认设置写入 .qmlformat.ini 并退出(警告:这将覆盖任何现有的设置和注释!)
–ignore-settings忽略所有设置文件,只考虑命令行选项
-i, –inplace在原地编辑文件,而不是输出到 stdout。
-f, –force即使发生错误也继续。
-t, –tabs使用制表符而不是空格。
-w, –indent-width <width>4缩进时使用的空格数。
-n, –normalize根据 QML 编码指南重新排序对象的属性。
-F, –files <file>就地格式化文件中列出的所有文件
-l, –newline <newline>覆盖要使用的新行格式(原生 macos unix windows)。
–objects-spacing确保对象之间有空格(仅与 normalize 选项一起使用)。
–functions-spacing确保函数之间有空格(仅与 normalize 选项一起使用)。

参数

参数
文件名

详情

qmlformat 是灵活的,可以根据您的需求进行配置。

输出

qmlformat 将格式化后的文件版本写入 stdout。如果要更新文件,请指定 -i 标志。

将属性、函数和信号组合在一起

使用 -n--normalize 标志时,qmlformat 将将所有属性、函数和信号组合在一起,而不是保留您指定的顺序。

设置文件

您可以通过在项目源代码或项目源代码文件夹的父目录中包含一个配置文件 .qmlformat.ini 来配置 qmlformat。可以通过传递 --write-defaults 标志来获取默认配置文件。这将在当前工作目录中生成 .qmlformat.ini 文件。

警告: --write-defaults 将覆盖任何现有的设置和注释!

格式化文件列表

虽然可以将要格式化的文件列表作为参数传递,但 qmlformat 提供了 -F 选项来格式化存储在文件中的一组文件。在这种情况下,格式化将就地发生。

// FileList.txt
main.qml
mycomponent.qml

然后,使用它如下所示

qmlformat -F FileList.txt

注意:如果文件中包含无效条目,例如,不存在的文件路径或有效的文件路径但内容是无效的 qml 文档,那么 qmlformat 将为该特定条目报错。它仍然将有效文件条目就地格式化。

警告:如果您提供 -F 选项,qmlformat 将忽略位置参数。

© 2024 Qt 公司有限。本文件中包含的文档贡献是各自所有者的版权。本提供的文档是根据自由软件基金会发布的 GNU 自由文档许可证版本 1.3 的条款许可的。Qt 及其相关标志是芬兰及/或世界其他地区的 Qt 公司的商标。所有其他商标均为各自所有者的财产。