fix djlint

Signed-off-by: Kashish Mittal <kmittal@redhat.com>

Author: 04kash

skills/rhdh-templates/scripts/validate.py

@@ -159,32 +159,75 @@ def check_location_yaml(repo_root: Path) -> list[dict]:
     return findings
 
 
-def run_djlint(skeleton_dir: Path) -> list[dict]:
-    import shutil
+# djlint defaults to --extension=html; scaffolder skeletons are mostly non-HTML.
+SKELETON_LINT_SKIP_SUFFIXES = frozenset(
+    {
+        ".png",
+        ".jpg",
+        ".jpeg",
+        ".gif",
+        ".webp",
+        ".ico",
+        ".svg",
+        ".pdf",
+        ".zip",
+        ".tar",
+        ".gz",
+        ".bz2",
+        ".xz",
+        ".7z",
+        ".jar",
+        ".war",
+        ".ear",
+        ".class",
+        ".so",
+        ".dll",
+        ".dylib",
+        ".exe",
+        ".bin",
+        ".dat",
+        ".woff",
+        ".woff2",
+        ".ttf",
+        ".eot",
+        ".mp3",
+        ".mp4",
+        ".avi",
+        ".mov",
+        ".wav",
+    }
+)
 
-    if not shutil.which("djlint"):
-        return [
-            {
-                "check": "nunjucks_lint",
-                "severity": "info",
-                "message": "djlint not installed — skipping Nunjucks lint",
-            }
-        ]
-    cmd = [
-        "djlint",
-        str(skeleton_dir),
-        "--profile=jinja",
-        "--lint",
-        "--quiet",
-    ]
-    try:
-        proc = subprocess.run(cmd, capture_output=True, text=True, check=False)
-    except OSError as exc:
+
+def collect_skeleton_lint_targets(skeleton_dir: Path) -> tuple[set[str], list[Path]]:
+    """Return (extensions, extensionless files) djlint should lint under skeleton/."""
+    extensions: set[str] = set()
+    extensionless: list[Path] = []
+    for path in skeleton_dir.rglob("*"):
+        if not path.is_file():
+            continue
+        suffix = path.suffix.lower()
+        if suffix in SKELETON_LINT_SKIP_SUFFIXES:
+            continue
+        try:
+            path.read_text(encoding="utf-8")
+        except (UnicodeDecodeError, OSError):
+            continue
+        if suffix:
+            extensions.add(suffix.lstrip("."))
+        else:
+            extensionless.append(path)
+    return extensions, sorted(extensionless)
+
+
+def _parse_djlint_output(proc: subprocess.CompletedProcess) -> list[dict]:
+    combined = f"{proc.stdout}\n{proc.stderr}"
+    if "No files to check" in combined:
         return [
             {
                 "check": "nunjucks_lint",
-                "severity": "info",
-                "message": f"djlint skipped: {exc}",
+                "severity": "warning",
+                "message": "djlint found no files to check for this target",
             }
         ]
     if proc.returncode == 0:
@@ -212,6 +255,75 @@ def run_djlint(skeleton_dir: Path) -> list[dict]:
     return findings
 
 
+def _run_djlint_cmd(cmd: list[str]) -> list[dict]:
+    try:
+        proc = subprocess.run(cmd, capture_output=True, text=True, check=False)
+    except OSError as exc:
+        return [
+            {
+                "check": "nunjucks_lint",
+                "severity": "info",
+                "message": f"djlint skipped: {exc}",
+            }
+        ]
+    return _parse_djlint_output(proc)
+
+
+def run_djlint(skeleton_dir: Path) -> list[dict]:
+    import shutil
+
+    if not shutil.which("djlint"):
+        return [
+            {
+                "check": "nunjucks_lint",
+                "severity": "info",
+                "message": "djlint not installed — skipping Nunjucks lint",
+            }
+        ]
+
+    extensions, extensionless = collect_skeleton_lint_targets(skeleton_dir)
+    if not extensions and not extensionless:
+        file_count = sum(1 for path in skeleton_dir.rglob("*") if path.is_file())
+        if file_count:
+            return [
+                {
+                    "check": "nunjucks_lint",
+                    "severity": "info",
+                    "message": "No readable text skeleton files to lint",
+                }
+            ]
+        return [
+            {
+                "check": "nunjucks_lint",
+                "severity": "info",
+                "message": "Skeleton directory is empty — nothing to lint",
+            }
+        ]
+
+    findings: list[dict] = []
+    for ext in sorted(extensions):
+        cmd = [
+            "djlint",
+            str(skeleton_dir),
+            "-e",
+            ext,
+            "--profile=jinja",
+            "--lint",
+            "--quiet",
+        ]
+        findings.extend(_run_djlint_cmd(cmd))
+    for path in extensionless:
+        cmd = [
+            "djlint",
+            str(path),
+            "--profile=jinja",
+            "--lint",
+            "--quiet",
+        ]
+        findings.extend(_run_djlint_cmd(cmd))
+    return findings
+
+
 def validate_template(
     path: Path, *, check_repo: bool, lint_skeleton: bool, use_jsonschema: bool = True
 ) -> dict:

tests/unit/test_rhdh_templates.py

@@ -375,6 +375,63 @@ def test_minimal_example_passes(self) -> None:
         assert data["ok"] is True
         assert data["critical_count"] == 0
 
+    def test_collect_skeleton_lint_targets_includes_non_html_extensions(self) -> None:
+        sys.path.insert(0, str(SCRIPTS))
+        import validate
+
+        skeleton = BUNDLED_EXAMPLES / "java-springboot" / "skeleton"
+        extensions, extensionless = validate.collect_skeleton_lint_targets(skeleton)
+        assert {"java", "md", "properties", "xml", "yaml"}.issubset(extensions)
+        assert extensionless == []
+
+    def test_run_djlint_uses_per_extension_targets(self, monkeypatch, tmp_path: Path) -> None:
+        sys.path.insert(0, str(SCRIPTS))
+        import validate
+
+        skeleton = tmp_path / "skeleton"
+        skeleton.mkdir()
+        (skeleton / "App.java").write_text("public class App {}\n", encoding="utf-8")
+        (skeleton / "config.yaml").write_text("name: {{ values.name }}\n", encoding="utf-8")
+
+        calls: list[list[str]] = []
+
+        def fake_run(cmd, **kwargs):
+            calls.append(cmd)
+            return subprocess.CompletedProcess(cmd, 0, stdout="", stderr="")
+
+        monkeypatch.setattr(subprocess, "run", fake_run)
+        monkeypatch.setattr("shutil.which", lambda _: "/usr/bin/djlint")
+
+        findings = validate.run_djlint(skeleton)
+        assert findings == []
+        assert len(calls) == 2
+        assert all(call[0] == "djlint" for call in calls)
+        assert all("-e" in call for call in calls)
+        used_extensions = {call[call.index("-e") + 1] for call in calls}
+        assert used_extensions == {"java", "yaml"}
+
+    def test_run_djlint_warns_when_djlint_checks_nothing(self, monkeypatch, tmp_path: Path) -> None:
+        sys.path.insert(0, str(SCRIPTS))
+        import validate
+
+        skeleton = tmp_path / "skeleton"
+        skeleton.mkdir()
+        (skeleton / "config.yaml").write_text("name: test\n", encoding="utf-8")
+
+        def fake_run(cmd, **kwargs):
+            return subprocess.CompletedProcess(
+                cmd, 0, stdout="", stderr="No files to check! 😢"
+            )
+
+        monkeypatch.setattr(subprocess, "run", fake_run)
+        monkeypatch.setattr("shutil.which", lambda _: "/usr/bin/djlint")
+
+        findings = validate.run_djlint(skeleton)
+        assert any(
+            f["check"] == "nunjucks_lint" and "no files to check" in f["message"].lower()
+            for f in findings
+        )
+
     def test_detects_bad_api_version(self, tmp_path: Path) -> None:
         bad = tmp_path / "template.yaml"
         bad.write_text(