Fix/dont substitute emoji in log text (#312)

* fix(console): don't substitute emoji glyphs in log text

Rich replaced shortcodes like :Package: with an emoji, so a concept named
:Package: showed up as a glyph in error messages instead of its name. The
log methods now print with emoji substitution off.

* test(console): move the bracket test into TestTerminalTextRendersVerbatim

The test checks that text prints unchanged, not that colors are applied,
so it sat in the wrong class. The test body is unchanged.

* test(console): give each log-text setting its own test

One test checked markup and highlighting at once, so a markup failure hid
the highlighting assertion. The highlighting assertion could also never
fail under pytest, because Rich emits no color codes unless it believes it
is writing to a colored terminal, so that test now forces one.

* fix(console): turn emoji substitution off globally

print_list and print_files print directly instead of going through the log
methods, so they still replaced shortcodes with glyphs. Passing emoji=False
to print does not reach file names inside the tree, so the console itself is
now built with emoji off.

* docs(console): move the emoji comment

Author: bananaplain

plain2code_console.py

@@ -27,7 +27,7 @@ class Plain2CodeConsole(Console):
     DEBUG_STYLE = Style(color="purple")
 
     def __init__(self):
-        super().__init__()
+        super().__init__(emoji=False)
         try:
             import tiktoken
 
@@ -66,9 +66,10 @@ def _log_and_print(self, level, base_style, args, color, kwargs):
         """
         logger.log(level, " ".join(map(str, args)), extra={"log_color": color})
         style = base_style + Style(color=color) if color else base_style
-        # Log messages must render exactly as logged: don't interpret square brackets
-        # in interpolated content (error texts, file names) as Rich markup, and don't
-        # let the repr highlighter restyle brackets and numbers inside them.
+        # Messages must render exactly as logged and not pick its own styling:
+        # -- no Rich markup (via square brackets) in interpolated content (error texts, file names)
+        # -- no repr highlighter restyling brackets and numbers inside them.
+        # -- no emoji substitution, but it's set False in __init__, otherwise it won't reach renderables like Trees
         kwargs.setdefault("markup", False)
         kwargs.setdefault("highlight", False)
         super().print(*args, **kwargs, style=style)

tests/test_console_log_styles.py

@@ -70,14 +70,70 @@ def test_no_color_defaults_to_none(self):
 
         assert handler.records[0].log_color is None
 
-    def test_bracketed_error_text_prints_verbatim(self):
-        console, handler = make_console_with_capture()
-        console.quiet = False
+
+class TestTerminalTextRendersVerbatim:
+    """
+    Message text must reach the terminal unchanged, and must not influence its own
+    styling. Colors are still applied but they are chosen by the call, never parsed
+    out of the text:
+     - Rich markup tags must not be interpreted
+     - the repr highlighter must not restyle brackets and numbers
+     - emoji shortcodes must not be substituted by glyphs
+    """
+
+    def test_markup_closing_tag_prints_verbatim(self):
+        console = Plain2CodeConsole()
         with console.capture() as capture:
-            console.info("Error: [Errno 8] failed [/closing] tag", color=RETRY_COLOR)
-        assert "[Errno 8]" in capture.get()
+            console.error("Error: [/closing] tag")
+        # markup=True raises MarkupError on an unmatched closing tag
         assert "[/closing]" in capture.get()
 
+    def test_markup_style_tag_prints_verbatim(self):
+        console = Plain2CodeConsole()
+        with console.capture() as capture:
+            console.error("Error: [bold]important text")
+        # markup=True silently consumes the tag and styles the rest
+        assert "[bold]" in capture.get()
+
+    def test_bracketed_number_prints_verbatim(self, monkeypatch):
+        # Rich emits no ANSI unless it believes it is writing to a colored terminal
+        # (FORCE_COLOR alone is not enough: TERM=dumb still resolves to no colors)
+        monkeypatch.setenv("FORCE_COLOR", "1")
+        monkeypatch.setenv("TERM", "xterm-256color")
+        console = Plain2CodeConsole()
+        assert console.color_system is not None  # should fail test immediately if no colors
+
+        with console.capture() as capture:
+            console.error("Error: [Errno 8] failed")
+        # highlight=True breaks this up with colour codes
+        assert "[Errno 8]" in capture.get()
+
+    def test_concept_name_matching_emoji_prints_verbatim(self):
+        console = Plain2CodeConsole()
+        with console.capture() as capture:
+            console.error("Syntax error: Invalid concept: :Package:")
+        assert ":Package:" in capture.get()
+        assert "📦" not in capture.get()
+
+
+class TestPrintHelpersDoNotSubstituteEmoji:
+    """
+    Same rule as TestTerminalTextRendersVerbatim, for the two helpers that bypass _log_and_print.
+    Only emoji is covered here, markup and highlighting still apply to them.
+    """
+
+    def test_print_list_does_not_substitute_emoji(self):
+        console = Plain2CodeConsole()
+        with console.capture() as capture:
+            console.print_list(["The :Package: is a concept"])
+        assert ":Package:" in capture.get()
+
+    def test_print_files_does_not_substitute_emoji_in_tree_labels(self):
+        console = Plain2CodeConsole()
+        with console.capture() as capture:
+            console.print_files("Files added:", "build", {":Package:.py": "x"})
+        assert ":Package:" in capture.get()
+
 
 class TestLoggingHandlerForwardsColor:
     """LoggingHandler must forward the log_color record attribute into LogMessageEmitted."""