feat: allow to manually disable report (#1543)

Author: bhirsz

docs/linter/reports/print_issues.md

@@ -99,3 +99,24 @@ Format of the **simple** output type can be configured with the global ``--issue
         "print_issues.issue_format={source}"
     ]
     ```
+
+## Disable print_issues report
+
+To turn off a ``print_issues`` report, set enabled to``False``:
+
+=== ":octicons-command-palette-24: cli"
+
+    ```bash
+    robocop check --configure print_issues.enabled=False
+    ```
+
+=== ":material-file-cog-outline: toml"
+
+    ```toml
+    [tool.robocop.lint]
+    configure = [
+        "print_issues.enabled=False"
+    ]
+    ```
+
+If the goal is to disable all output, use [``--silent``](../../configuration/configuration_reference.md#silent)  instead.

docs/linter/reports/reports.md

@@ -171,3 +171,25 @@ use. Use special keyword ``None`` to not run any reports even if configured:
 ```bash
 robocop check --reports sarif,all,None
 ```
+
+## Disable specific report
+
+To turn off a specific report, even if it’s enabled by configuration or by default (``print_issues``), set enabled to
+``False``:
+
+=== ":octicons-command-palette-24: cli"
+
+    ```bash
+    robocop check --configure print_issues.enabled=False
+    ```
+
+=== ":material-file-cog-outline: toml"
+
+    ```toml
+    [tool.robocop.lint]
+    configure = [
+        "print_issues.enabled=False"
+    ]
+    ```
+
+``enabled`` cannot be used to enable a report - use ``reports`` option instead.

docs/releasenotes/changelog.md

@@ -15,6 +15,8 @@ Example configuration:
 "ignore_file_in_subpath/test2.robot" = ["SPC10"]
 ```
 
+- Allow manually disabling reports with ``enabled=False``. It can be used to disable default ``print_issues`` report ([issue #1540](https://github.com/MarketSquare/robotframework-robocop/issues/1540))
+
 ### Fixes
 
 - Fix piping output (``robocop check > output.txt``) not working on Windows because of code lines converted to emojis ([issue #1539](https://github.com/MarketSquare/robotframework-robocop/issues/1539))

src/robocop/linter/reports/__init__.py

@@ -37,7 +37,7 @@ def generate_report(self, **kwargs) -> NoReturn:
 
 
 class JsonFileReport(Report):
-    """Base class for report that generates json-based file."""
+    """Base class for a report that generates a json-based file."""
 
     def __init__(self, output_path: str, config: Config) -> None:
         self.output_path = output_path
@@ -76,7 +76,7 @@ def load_reports(config: Config) -> dict[str, type[Report]]:
     """
     Load all valid reports.
 
-    Report is considered valid if it inherits from `Report` class
+    Report is considered valid if it inherits from the ` Report ` class
     and contains both `name` and `description` attributes.
     """
     reports = {}
@@ -95,9 +95,9 @@ def load_reports(config: Config) -> dict[str, type[Report]]:
 
 def get_reports(config: Config):
     """
-    Return dictionary with list of valid, enabled reports (listed in `configured_reports` set of str).
+    Return the dictionary with a list of valid, enabled reports (listed in `configured_reports` set of str).
 
-    If `configured_reports` contains `all` then all default reports are enabled.
+    If `configured_reports` contains `all`, then all default reports are enabled.
     """
     configured_reports = config.linter.reports
     configured_reports = [csv_report for report in configured_reports for csv_report in report.split(",")]
@@ -124,8 +124,8 @@ def print_reports(reports: dict[str, Report], only_enabled: bool | None) -> str:
     """
     Return description of reports.
 
-    The reports list is filtered and only public reports are provided. If the report is enabled in current
-    configuration it will have (enabled) suffix (and (disabled) if it is disabled).
+    The report list is filtered and only public reports are provided. If the report is enabled in the current
+    configuration, it will have (enabled) suffix (and (disabled) if it is disabled).
 
     Args:
         reports: Dictionary with loaded reports.
@@ -171,11 +171,11 @@ def load_reports_result_from_cache():
 
 def save_reports_result_to_cache(working_dir: str, report_results: dict) -> None:
     """
-    Save results from Robocop reports to json file.
+    Save results from Robocop reports to JSON file.
 
-    Result file contains results grouped using working directory.
+    The result file contains results grouped using a working directory.
     That's why we are loading previous results and overwriting only
-    the results for current working directory.
+    the results for the current working directory.
     """
     cache_dir = get_robocop_cache_directory(ensure_exists=True)
     cache_file = cache_dir / ROBOCOP_CACHE_FILE

src/robocop/linter/runner.py

@@ -170,7 +170,12 @@ def configure_reports(self):
                 param, value = param_and_value.split("=", maxsplit=1)
             except ValueError:
                 raise exceptions.InvalidConfigurationFormatError(config) from None
-            if name in self.reports:
+            if name not in self.reports:
+                continue
+            if param == "enabled":
+                if value.lower() == "false":
+                    del self.reports[name]
+            else:
                 self.reports[name].configure(param, value)
 
     def make_reports(self) -> None:

tests/linter/reports/test_reports.py

@@ -11,6 +11,8 @@
     load_reports_result_from_cache,
     save_reports_result_to_cache,
 )
+from robocop.run import check_files
+from tests import working_directory
 
 
 @pytest.mark.parametrize(
@@ -108,3 +110,16 @@ def test_load_save_with_invalid_file(prepare_file_fn):
     save_reports_result_to_cache(root_1, root_1_content)
     result = load_reports_result_from_cache()
     assert result == expected_result
+
+
+def test_disabled_report_manually(tmp_path, capsys):
+    # Arrange
+    (tmp_path / "test.robot").write_text("*** Settings ***\n\n")
+    # Act
+    with working_directory(tmp_path):
+        check_files(
+            ignore_file_config=True, return_result=True, reports=["all"], configure=["print_issues.enabled=False"]
+        )
+    out, _ = capsys.readouterr()
+    # Assert
+    assert "test.robot:1:1 DOC03 Missing documentation in suite" not in out