Improve new checks logs visibility (#215)

* Improve new checks logs
* Change implementation to display all new checks warnings separately in the end

Author: Aymen-Soussi-01

src/extensions/score_metamodel/__init__.py

@@ -141,12 +141,14 @@ def is_check_enabled(check: local_check_function | graph_check_function):
         check(app, needs_all_needs, log)
 
     if log.has_warnings:
-        log.warning("Some needs have issues. See the log for more information.")
+        logger.warning("Some needs have issues. See the log for more information.")
 
     if log.has_infos:
-        log.info(
-            "Some needs have issues related to the new checks. "
-            "See the log for more information."
+        log.flush_new_checks()
+        logger.info(
+            "\n\nThese next warnings are displayed as info statements for now. "
+            "They will become real warnings in the future. "
+            "Please fix them as soon as possible.\n"
         )
         # TODO: exit code
 

src/extensions/score_metamodel/log.py

@@ -14,16 +14,22 @@
 from typing import Any
 
 from docutils.nodes import Node
+from sphinx_needs import logging
 from sphinx_needs.data import NeedsInfoType
 from sphinx_needs.logging import SphinxLoggerAdapter
 
+Location = str | tuple[str | None, int | None] | Node | None
+NewCheck = tuple[str, Location]
+logger = logging.get_logger(__name__)
+
 
 class CheckLogger:
     def __init__(self, log: SphinxLoggerAdapter, prefix: str):
         self._log = log
         self._info_count = 0
         self._warning_count = 0
         self._prefix = prefix
+        self._new_checks: list[NewCheck] = []
 
     @staticmethod
     def _location(need: NeedsInfoType, prefix: str):
@@ -43,47 +49,45 @@ def get(key: str) -> Any:
         return None
 
     def warning_for_option(
-        self, need: NeedsInfoType, option: str, msg: str, new_check: bool = False
+        self, need: NeedsInfoType, option: str, msg: str, is_new_check: bool = False
     ):
         full_msg = f"{need['id']}.{option} ({need.get(option, None)}): {msg}"
         location = CheckLogger._location(need, self._prefix)
-        self._log_message(full_msg, location, new_check)
+        self._log_message(full_msg, location, is_new_check)
 
-    def warning_for_need(self, need: NeedsInfoType, msg: str, new_check: bool = False):
+    def warning_for_need(
+        self, need: NeedsInfoType, msg: str, is_new_check: bool = False
+    ):
         full_msg = f"{need['id']}: {msg}"
         location = CheckLogger._location(need, self._prefix)
-        self._log_message(full_msg, location, new_check)
+        self._log_message(full_msg, location, is_new_check)
 
     def _log_message(
         self,
         msg: str,
-        location: None | str | tuple[str | None, int | None] | Node = None,
-        is_info: bool = False,
+        location: Location,
+        is_new_check: bool = False,
     ):
-        if is_info:
-            msg += (
-                "\nPlease fix this warning related to the new check "
-                "before the release of the next version of Docs-As-Code."
-            )
-            self.info(msg, location)
+        if is_new_check:
+            self._new_checks.append((msg, location))
+            self._info_count += 1
         else:
             self.warning(msg, location)
+            self._warning_count += 1
 
     def info(
         self,
         msg: str,
-        location: None | str | tuple[str | None, int | None] | Node = None,
+        location: Location,
     ):
         self._log.info(msg, type="score_metamodel", location=location)
-        self._info_count += 1
 
     def warning(
         self,
         msg: str,
-        location: None | str | tuple[str | None, int | None] | Node = None,
+        location: Location,
     ):
         self._log.warning(msg, type="score_metamodel", location=location)
-        self._warning_count += 1
 
     @property
     def has_warnings(self):
@@ -92,3 +96,27 @@ def has_warnings(self):
     @property
     def has_infos(self):
         return self._info_count > 0
+
+    def flush_new_checks(self):
+        """Log all new-check messages together at once."""
+
+        def make_header_line(text: str, width: int = 80) -> str:
+            """Center a header inside '=' padding so line length stays fixed."""
+            text = f" {text} "
+            return text.center(width, "=")
+
+        if not self._new_checks:
+            return
+
+        info_header = make_header_line("[INFO MESSAGE]")
+        separator = "=" * 80
+        warning_header = make_header_line(
+            f"[New Checks] has {len(self._new_checks)} warnings"
+        )
+
+        logger.info(info_header)
+        logger.info(separator)
+        logger.info(warning_header)
+
+        for msg, location in self._new_checks:
+            self.info(msg, location)