Initial implementation

Author: cottsay

colcon_ansi_colors_example/output_style/__init__.py

@@ -0,0 +1,82 @@
+# Copyright 2025 Open Source Robotics Foundation, Inc.
+# Licensed under the Apache License, Version 2.0
+
+import os
+
+from colcon_core.output_style import OutputStyleExtensionPoint
+from colcon_core.output_style import Stylizer
+from colcon_core.plugin_system import satisfies_version
+
+
+class AnsiEscape(Stylizer):
+    """ANSI text style modifier."""
+
+    __slots__ = ()
+
+    def __new__(cls, start, end=0):  # noqa: D102
+        return super().__new__(
+            cls, f'\033[{start}m',
+            f'\033[{end}m' if end is not None else '')
+
+    def __add__(self, other):  # noqa: D105
+        if not isinstance(other, AnsiEscape):
+            return super().__add__(other)
+        return AnsiEscape(
+            self._combine(self.start, other.start),
+            self._combine(other.end, self.end))
+
+    @staticmethod
+    def _combine(first, second):
+        if not second or first == second:
+            return first
+        elif not first:
+            return second
+        first = first[2:-1]
+        second = second[2:-1]
+        return f'{first};{second}'
+
+
+AnsiEscape.Black = AnsiEscape(30)
+AnsiEscape.Blue = AnsiEscape(34)
+AnsiEscape.Bright = AnsiEscape(1, 22)
+AnsiEscape.Cyan = AnsiEscape(36)
+AnsiEscape.Default = AnsiEscape(39, None) + AnsiEscape(49, None)
+AnsiEscape.Faint = AnsiEscape(2, 22)
+AnsiEscape.Flashing = AnsiEscape(5, 25)
+AnsiEscape.Green = AnsiEscape(32)
+AnsiEscape.Invert = AnsiEscape(7, 27)
+AnsiEscape.Italic = AnsiEscape(3, 23)
+AnsiEscape.Magenta = AnsiEscape(35)
+AnsiEscape.Red = AnsiEscape(31)
+AnsiEscape.Strike = AnsiEscape(9, 29)
+AnsiEscape.Underline = AnsiEscape(4, 24)
+AnsiEscape.White = AnsiEscape(37)
+AnsiEscape.Yellow = AnsiEscape(33)
+
+
+class CatkinToolsOutputStyle(OutputStyleExtensionPoint):
+    """Basic ANSI colorizing for console output like catkin-tools."""
+
+    PRIORITY = 90
+
+    def __init__(self):  # noqa: D107
+        super().__init__()
+        satisfies_version(
+            OutputStyleExtensionPoint.EXTENSION_POINT_VERSION, '^1.0')
+
+    def apply_style(self, style):  # noqa: D102
+        if os.environ.get('NO_COLOR'):
+            return
+
+        style.Critical = AnsiEscape.Bright + AnsiEscape.Red
+        style.Default = AnsiEscape.Default
+        style.Error = AnsiEscape.Red
+        style.Measurement = AnsiEscape.Yellow
+        style.PackageOrJobName = AnsiEscape.Cyan
+        style.Pictogram = AnsiEscape.Bright + AnsiEscape.Green
+        style.SectionStart = AnsiEscape.Default
+        style.SectionEnd = AnsiEscape.Bright + AnsiEscape.Black
+        style.Strong = AnsiEscape.Bright
+        style.Success = AnsiEscape.Green
+        style.Warning = AnsiEscape.Yellow
+        style.Weak = AnsiEscape.Faint

colcon_ansi_colors_example/output_style/catkin_tools.py

@@ -52,6 +52,8 @@ markers =
   linter
 
 [options.entry_points]
+colcon_core.output_style =
+  catkin_tools = colcon_ansi_colors_example.output_style.catkin_tools:CatkinToolsOutputStyle
 
 [flake8]
 import-order-style = google

setup.cfg

@@ -3,9 +3,13 @@ apache
 colcon
 iterdir
 linter
+noqa
 pathlib
+plugin
 pydocstyle
 pytest
 scspell
 setuptools
+staticmethod
+stylizer
 thomas