intro message on output

Author: jonhealy1

CHANGELOG.md

@@ -12,7 +12,8 @@ The format is (loosely) based on [Keep a Changelog](http://keepachangelog.com/)
 
 - Results summary for options that produce numerous results, ie. --collections, --item-collection, --recursive ([#138](https://github.com/stac-utils/stac-check/pull/138))
 - Support for --verbose flag to show verbose results summary ([#138](https://github.com/stac-utils/stac-check/pull/138))
-- Added `--output`/`-o` option to save validation results to a file ([#139](https://github.com/stac-utils/stac-check/pull/139))
+- Added `--output`/`-o` option to save validation results to a file ([#138](https://github.com/stac-utils/stac-check/pull/138))
+- Tests for CLI options ([#138](https://github.com/stac-utils/stac-check/pull/138))
 
 ## [v1.10.1] - 2025-06-21
 

stac_check/cli.py

@@ -13,6 +13,7 @@
     recursive_message,
 )
 from stac_check.lint import Linter
+from stac_check.utilities import handle_output
 
 
 @click.option(
@@ -152,32 +153,11 @@ def main(
             verbose=verbose,
         )
 
-        # Handle output to file if specified
-        if output:
-            original_stdout = sys.stdout
-            try:
-                with open(output, "w") as f:
-                    sys.stdout = f
-                    intro_message(display_linter)
-                    if collections:
-                        collections_message(
-                            api_linter,
-                            results=results,
-                            cli_message_func=cli_message,
-                            verbose=verbose,
-                        )
-                    elif item_collection:
-                        item_collection_message(
-                            api_linter,
-                            results=results,
-                            cli_message_func=cli_message,
-                            verbose=verbose,
-                        )
-            finally:
-                sys.stdout = original_stdout
-            click.echo(f"Output written to {output}", err=True)
-        else:
-            intro_message(display_linter)
+        # Show intro message in the terminal
+        intro_message(display_linter)
+
+        # Define output generation function (without intro message since we already showed it)
+        def generate_output():
             if collections:
                 collections_message(
                     api_linter,
@@ -192,6 +172,9 @@ def main(
                     cli_message_func=cli_message,
                     verbose=verbose,
                 )
+
+        # Handle output (without duplicating the intro message)
+        handle_output(output, generate_output)
         sys.exit(0 if all(msg.get("valid_stac") is True for msg in results) else 1)
     else:
         # Handle file-based validation (single file or recursive)
@@ -209,23 +192,17 @@ def main(
 
         intro_message(linter)
 
-        # Handle output to file if specified and recursive
-        if output and recursive:
-            original_stdout = sys.stdout
-            try:
-                with open(output, "w") as f:
-                    sys.stdout = f
-                    recursive_message(
-                        linter, cli_message_func=cli_message, verbose=verbose
-                    )
-            finally:
-                sys.stdout = original_stdout
-            click.echo(f"Output written to {output}", err=True)
-        # Handle recursive validation without output file
-        elif recursive:
-            recursive_message(linter, cli_message_func=cli_message, verbose=verbose)
-        # Handle single file validation
-        else:
-            cli_message(linter)
+        # Show intro message in the terminal
+        intro_message(linter)
+
+        # Define output generation function (without intro message since we already showed it)
+        def generate_output():
+            if recursive:
+                recursive_message(linter, cli_message_func=cli_message, verbose=verbose)
+            else:
+                cli_message(linter)
+
+        # Handle output (without duplicating the intro message)
+        handle_output(output if recursive else None, generate_output)
 
         sys.exit(0 if linter.valid_stac else 1)

stac_check/utilities.py

@@ -1,3 +1,9 @@
+import contextlib
+from typing import Callable
+
+import click
+
+
 def determine_asset_type(data):
     """Determine the STAC asset type from the given data dictionary.
 
@@ -35,6 +41,32 @@ def determine_asset_type(data):
     return ""
 
 
+def handle_output(
+    output_file: str, callback: Callable[[], None], output_path: str = None
+) -> None:
+    """Helper function to handle output redirection to a file or stdout.
+
+    Args:
+        output_file: Path to the output file, or None to use stdout
+        callback: Function that performs the actual output generation
+        output_path: Optional path to display in the success message
+    """
+
+    if output_file:
+        with open(output_file, "w") as f:
+            with contextlib.redirect_stdout(f):
+                callback()
+        click.secho(
+            f"Output written to {output_path or output_file}",
+            fg="green",
+            err=True,
+            bold=True,
+        )
+        click.secho()
+    else:
+        callback()
+
+
 def format_verbose_error(error_data):
     """Format verbose error data into a human-readable string."""
     if not error_data or not isinstance(error_data, dict):