Add QML format checking to CI

Also expands the Python file glob to include more files.

Author: jayvdb

Makefile.toml

@@ -1,11 +1,32 @@
+env_scripts = [
+# Two proposed methods of simplifying path globbing
+# https://github.com/sagiegurari/cargo-make/issues/542
+# https://github.com/sagiegurari/cargo-make/issues/543
+'''
+#!@duckscript
+!include_files ./utils/glob.ds
+
+py_files = glob_paths_excluding_target ./**/*.py
+
+set_env PYTHON_FILES ${py_files}
+echo PYTHON_FILES=${py_files}
+
+qml_files = glob_paths_excluding_target resources/**/*.qml
+
+set_env QML_FILES ${qml_files}
+echo QML_FILES=${qml_files}
+''']
+
 [env]
-PYTHON_FILES = { script = ["python utils/glob_python_files.py"] }
 CONDA_ENV = "console_pp"
 REQUIREMENTS_FILE = "requirements.txt"
 REQUIREMENTS_DEV_FILE = "requirements-dev.txt"
 
 [config]
 default_to_workspace = false
+init_task = "init"
+
+[tasks.init]
 
 [tasks.poetry-export-dev]
 script_runner = "@shell"
@@ -172,6 +193,20 @@ conda run -n $CONDA_ENV python src/build/generate-mac-info-plist.py
 hdiutil create -volname SwiftNavConsole -srcfolder main.app -ov -format UDZO 'swift_navigation_console.dmg'
 '''
 
+[tasks.qml-format.linux]
+env = { QT_APP = { script = ["conda run -n $CONDA_ENV python utils/echo-qt-dir.py"] } }
+script_runner = "@shell"
+script = '''
+${QT_APP}/Qt/bin/qmlformat -i $QML_FILES
+'''
+
+[tasks.qml-format-check.linux]
+dependencies = ["qml-format"]
+script_runner = "@shell"
+script = '''
+git diff --exit-code -- $QML_FILES
+'''
+
 [tasks.rust-format]
 dependencies = ["copy-capnp"]
 command = "cargo"
@@ -225,13 +260,13 @@ conda run -n $CONDA_ENV pylint --output-format=parseable $PYTHON_FILES
 '''
 
 [tasks.format-all]
-dependencies = ["python-format-all", "rust-format"]
+dependencies = ["python-format-all", "qml-format", "rust-format"]
 
 [tasks.format]
 alias = "format-all"
 
 [tasks.format-check]
-dependencies = ["python-format-check", "rust-format-check"]
+dependencies = ["python-format-check", "qml-format-check", "rust-format-check"]
 
 [tasks.lint]
 dependencies = ["python-lint", "rust-lint", "format-check"]

poetry.lock

@@ -21,6 +21,7 @@ pkgconfig = "^1.5.1"
 Cython = "^0.29.21"
 nuitka = "^0.6.11"
 psutil = "5.8.0"
+qt5-applications = [{ version = "^5.15.2", platform = "linux" }]
 
 [build-system]
 requires = ["poetry-core>=1.0.0", "setuptools>=41.0.0", "wheel", "setuptools_rust>=0.10.2"]

pyproject.toml

@@ -34,6 +34,7 @@ pyparsing==2.4.7; python_version >= "3.5" and python_full_version < "3.0.0" or p
 pyside2==5.15.2; (python_version >= "2.7" and python_full_version < "3.0.0") or (python_full_version >= "3.5.0" and python_version < "3.10")
 pytest==5.4.3; python_version >= "3.5"
 pywin32-ctypes==0.2.0; sys_platform == "win32" and python_version >= "3.5"
+qt5-applications==5.15.2.2.1; sys_platform == "linux"
 regex==2020.11.13; python_version >= "3.6"
 semantic-version==2.8.5; python_version >= "3.5" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.5"
 setuptools-rust==0.11.6; python_version >= "3.5"

requirements-dev.txt

@@ -0,0 +1,8 @@
+import pathlib
+
+try:
+    import qt5_applications  # type: ignore
+
+    print(pathlib.Path(qt5_applications.__file__).parent)
+except ImportError:
+    pass

utils/echo-qt-dir.py

@@ -0,0 +1,11 @@
+fn glob_paths_excluding_target
+    handle = glob_array ${1}
+    out = array
+    for i in ${handle}
+        if not starts_with ${i} "target"
+            array_push ${out} ${i}
+        end
+    end
+    s = array_join ${out} " "
+    return ${s}
+end