fix: console output (#8)

Author: tzing

docs/images/screenshot.png

@@ -16,6 +16,7 @@ Tugboat is a linter to streamline your `Argo Workflows <https://argoproj.github.
       |               ^^^^^^^
       |               └ WF001 at .spec.entrypoint in test-
     7 |   templates:
+    8 |     - name: whalesay
 
       Entrypoint 'ducksay' is not defined in any template.
       Defined entrypoints: 'whalesay'.

readme.pkg.rst

@@ -3,7 +3,7 @@
 
 import pytest
 
-from tugboat.console.outputs.console import report
+from tugboat.console.outputs.console import _calc_highlight_range, report
 
 
 class TestReport:
@@ -46,6 +46,7 @@ def test_error(self, monkeypatch: pytest.MonkeyPatch, fixture_dir: Path):
             " 1 | apiVersion: argoproj.io/v1alpha1",
             "   | └ T01 at . in hello-world-",
             " 2 | kind: Workflow",
+            " 3 | metadata:",
             "",
             "   Test error message",
             "",
@@ -84,6 +85,7 @@ def test_failure(self, monkeypatch: pytest.MonkeyPatch, fixture_dir: Path):
             "   |               ^^^^^",
             "   |               └ T02 at .spec.entrypoint in hello-",
             " 7 |   templates:",
+            " 8 |     - name: hello",
             "",
             "   Test failure message",
             "",
@@ -121,6 +123,7 @@ def test_skipped(self, monkeypatch: pytest.MonkeyPatch, fixture_dir: Path):
             " 2 | kind: Workflow",
             "   | └ T03 at .kind in hello-world-",
             " 3 | metadata:",
+            " 4 |   generateName: hello-world-",
             "",
             "   Test skipped message",
             "",
@@ -159,3 +162,21 @@ def test_colored(
             output = stream.getvalue()
 
         assert isinstance(output, str)
+
+
+class TestCalcHighlightRange:
+
+    def test_success(self):
+        start, end = _calc_highlight_range("hello user 1234", 0, 1234)
+        assert start == 11
+        assert end == 15
+
+    def test_not_found(self):
+        assert _calc_highlight_range("hello world", 2, "hello") is None
+        assert _calc_highlight_range("hello world", 0, "not-found") is None
+
+    def test_empty(self):
+        assert _calc_highlight_range("hello world", 0, " ") is None
+
+    def test_none(self):
+        assert _calc_highlight_range("hello world; None", 0, None) is None

tests/console/test_output_console.py

@@ -11,7 +11,7 @@
 if typing.TYPE_CHECKING:
     from collections.abc import Callable, Iterator
     from pathlib import Path
-    from typing import IO
+    from typing import IO, Any
 
     from tugboat.analyze import AugmentedDiagnosis
 
@@ -73,9 +73,12 @@ def report_diagnosis(echo: Callable, file: Path, diagnosis: AugmentedDiagnosis):
             # default to the column number, but if the input is present, use that instead
             indent_before_caret = " " * max(diagnosis["column"] - 1, 0)
 
-            if diagnosis["input"] is not None and str(diagnosis["input"]) in line:
-                col_start = line.index(str(diagnosis["input"]))
-                col_end = col_start + len(str(diagnosis["input"]))
+            if range_ := _calc_highlight_range(
+                line=line,
+                offset=diagnosis["column"] - 1,
+                input_=diagnosis["input"],
+            ):
+                col_start, col_end = range_
                 indent_before_caret = " " * col_start
 
                 # print the underline
@@ -116,11 +119,31 @@ def report_diagnosis(echo: Callable, file: Path, diagnosis: AugmentedDiagnosis):
 def get_content_near(file: Path, target_line: int) -> Iterator[tuple[int, str]]:
     target_line -= 1  # 1-based to 0-based
     content = read_file(file).splitlines()
-    start = max(0, target_line - LINES_BEHIND)
-    end = min(len(content), target_line + LINES_AHEAD)
-    yield from enumerate(content[start:end], start + 1)
+    start = max(0, target_line - LINES_AHEAD)
+    end = min(len(content), target_line + LINES_BEHIND)
+    yield from enumerate(content[start : end + 1], start + 1)
 
 
 @functools.lru_cache(1)
 def read_file(path: Path) -> str:
     return path.read_text()
+
+
+def _calc_highlight_range(line: str, offset: int, input_: Any):
+    """
+    Calculate the range to highlight in the line.
+    """
+    if input_ is None:
+        return  # early escape if no value is provided
+
+    value = str(input_)
+    if not value.strip():
+        return  # prevent highlighting empty strings
+
+    try:
+        col_start = line.index(value, offset)
+    except ValueError:
+        return
+
+    col_end = col_start + len(value)
+    return col_start, col_end