Feat: improve format --check output

Author: georgesittas

sqlmesh/core/context.py

@@ -1062,7 +1062,9 @@ def format(
         **kwargs: t.Any,
     ) -> bool:
         """Format all SQL models and audits."""
+        unformatted_file_paths = []
         format_targets = {**self._models, **self._audits}
+
         for target in format_targets.values():
             if target._path is None or target._path.suffix != ".sql":
                 continue
@@ -1104,7 +1106,17 @@ def format(
                     file.write(after)
                     file.truncate()
                 elif before != after:
-                    return False
+                    unformatted_file_paths.append(target._path)
+
+        if unformatted_file_paths:
+            for path in unformatted_file_paths:
+                self.console.log_status_update(f"Would reformat {path}")
+
+            self.console.log_status_update(
+                f"\n{len(unformatted_file_paths)} file(s) would be reformatted."
+            )
+            return False
+
         return True
 
     @python_api_analytics

tests/core/test_format.py

@@ -1,14 +1,16 @@
 import pathlib
 
+from pytest_mock.plugin import MockerFixture
 from sqlmesh.core.config import Config
 from sqlmesh.core.context import Context
 from sqlmesh.core.dialect import parse
 from sqlmesh.core.audit import ModelAudit
 from sqlmesh.core.model import SqlModel, load_sql_based_model
 from tests.utils.test_filesystem import create_temp_file
+from unittest.mock import call
 
 
-def test_format_files(tmp_path: pathlib.Path):
+def test_format_files(tmp_path: pathlib.Path, mocker: MockerFixture):
     models_dir = pathlib.Path("models")
     audits_dir = pathlib.Path("audits")
 
@@ -35,6 +37,7 @@ def test_format_files(tmp_path: pathlib.Path):
 
     config = Config()
     context = Context(paths=tmp_path, config=config)
+    context.console = mocker.Mock()
     context.load()
 
     assert isinstance(context.get_model("this.model"), SqlModel)
@@ -54,6 +57,13 @@ def test_format_files(tmp_path: pathlib.Path):
     )
 
     assert not context.format(check=True)
+    assert context.console.log_status_update.mock_calls == [  # type: ignore
+        call(f"Would reformat {tmp_path}/models/model_3.sql"),
+        call(f"Would reformat {tmp_path}/models/model_2.sql"),
+        call(f"Would reformat {tmp_path}/models/model_1.sql"),
+        call(f"Would reformat {tmp_path}/audits/audit_1.sql"),
+        call("\n4 file(s) would be reformatted."),
+    ]
 
     # Transpile project to BigQuery
     context.format(transpile="bigquery")