refactor: set check=False in subprocess to hide subprocess's errors and only show the command's (e.g. ruff, pre-commit) original ones

Author: softwareentrepreneer

afterpython/cli/commands/build.py

@@ -11,6 +11,7 @@
 import subprocess
 
 import click
+from click.exceptions import Exit
 
 import afterpython as ap
 from afterpython.utils import find_node_env
@@ -151,7 +152,7 @@ def build(ctx, dev: bool, execute: bool):
             click.echo(f"Building {content_type}/...")
             # NOTE: needs to set BASE_URL so that the project website can link to the content pages correctly at e.g. localhost:5173/doc
             build_env = {**node_env, "BASE_URL": f"/{content_type}"}
-            subprocess.run(
+            result = subprocess.run(
                 [
                     "myst",
                     "build",
@@ -161,14 +162,18 @@ def build(ctx, dev: bool, execute: bool):
                 ],
                 cwd=content_path,
                 env=build_env,
-                check=True,
+                check=False,
             )
+            if result.returncode != 0:
+                raise Exit(result.returncode)
 
     postbuild()
 
     # website's production build
     if not dev:
         click.echo("Building project website...")
-        subprocess.run(
-            ["pnpm", "build"], cwd=paths.website_path, env=node_env, check=True
+        result = subprocess.run(
+            ["pnpm", "build"], cwd=paths.website_path, env=node_env, check=False
         )
+        if result.returncode != 0:
+            raise Exit(result.returncode)

afterpython/cli/commands/check.py

@@ -1,6 +1,7 @@
 import subprocess
 
 import click
+from click.exceptions import Exit
 
 
 @click.command(
@@ -17,6 +18,10 @@ def check(ctx):
     ruff_toml = paths.afterpython_path / "ruff.toml"
     if ruff_toml.exists():
         click.echo(f"Using ruff configuration from {ruff_toml}")
-        subprocess.run(["ruff", "check", "--config", str(ruff_toml), *ctx.args])
+        result = subprocess.run(
+            ["ruff", "check", "--config", str(ruff_toml), *ctx.args], check=False
+        )
     else:
-        subprocess.run(["ruff", "check", *ctx.args])
+        result = subprocess.run(["ruff", "check", *ctx.args], check=False)
+    if result.returncode != 0:
+        raise Exit(result.returncode)

afterpython/cli/commands/clean.py

@@ -8,6 +8,7 @@
 import subprocess
 
 import click
+from click.exceptions import Exit
 
 from afterpython.utils import find_node_env, has_content_for_myst
 from afterpython.const import CONTENT_TYPES
@@ -42,12 +43,14 @@ def clean(ctx, all: bool):
 
         click.echo(f"Cleaning {content_type}/...")
         # Pass through any extra args to myst clean (e.g., --cache, --templates)
-        subprocess.run(
+        result = subprocess.run(
             ["myst", "clean", *ctx.args, *(["--all"] if all else [])],
             cwd=content_path,
             env=node_env,
-            check=True,
+            check=False,
         )
+        if result.returncode != 0:
+            raise Exit(result.returncode)
 
     # Clean afterpython's build directories if --all flag is used
     if all:

afterpython/cli/commands/dev.py

@@ -8,6 +8,7 @@
 import subprocess
 
 import click
+from click.exceptions import Exit
 
 from afterpython.utils import find_node_env, find_available_port
 from afterpython.const import CONTENT_TYPES
@@ -55,7 +56,7 @@ def dev(ctx, all: bool, execute: bool, no_website: bool):
     paths = ctx.obj["paths"]
 
     # OPTIMIZE: should implement incremental build?
-    subprocess.run(["ap", "build", "--dev"], check=True)
+    subprocess.run(["ap", "build", "--dev"])
 
     def cleanup_processes():
         """Clean up all MyST server processes"""
@@ -115,9 +116,11 @@ def cleanup_processes():
         if not no_website:
             node_env: NodeEnv = find_node_env()
             click.echo("Running the web dev server...")
-            subprocess.run(
-                ["pnpm", "dev"], cwd=paths.website_path, env=node_env, check=True
+            result = subprocess.run(
+                ["pnpm", "dev"], cwd=paths.website_path, env=node_env, check=False
             )
+            if result.returncode != 0:
+                raise Exit(result.returncode)
         else:
             click.echo(
                 "Skipping website dev server (--no-website flag). Run 'pnpm dev' manually in afterpython/_website/ with your custom options."

afterpython/cli/commands/format.py

@@ -1,6 +1,7 @@
 import subprocess
 
 import click
+from click.exceptions import Exit
 
 
 @click.command(
@@ -13,4 +14,6 @@
 @click.pass_context
 def format(ctx):
     """Simple wrapper for ruff format for convenience"""
-    subprocess.run(["ruff", "format", *ctx.args])
+    result = subprocess.run(["ruff", "format", *ctx.args], check=False)
+    if result.returncode != 0:
+        raise Exit(result.returncode)

afterpython/cli/commands/install.py

@@ -1,6 +1,7 @@
 import subprocess
 
 import click
+from click.exceptions import Exit
 
 from afterpython.utils import has_uv
 
@@ -16,4 +17,6 @@ def install():
     if not has_uv():
         click.echo("uv not found. Please install uv first.")
         return
-    subprocess.run(["uv", "sync", "--all-extras", "--all-groups"], check=True)
+    result = subprocess.run(["uv", "sync", "--all-extras", "--all-groups"], check=False)
+    if result.returncode != 0:
+        raise Exit(result.returncode)

afterpython/cli/commands/preview.py

@@ -1,6 +1,7 @@
 import subprocess
 
 import click
+from click.exceptions import Exit
 
 
 @click.command()
@@ -14,6 +15,8 @@ def preview(ctx):
     click.echo(
         "Previewing the production build of the project website (including myst's builds)..."
     )
-    subprocess.run(
-        ["pnpm", "preview"], cwd=paths.website_path, env=node_env, check=True
+    result = subprocess.run(
+        ["pnpm", "preview"], cwd=paths.website_path, env=node_env, check=False
     )
+    if result.returncode != 0:
+        raise Exit(result.returncode)

afterpython/cli/commands/start.py

@@ -7,6 +7,7 @@
 import subprocess
 
 import click
+from click.exceptions import Exit
 
 
 command_kwargs = {
@@ -73,9 +74,11 @@ def start(ctx, doc: bool, blog: bool, tutorial: bool, example: bool, guide: bool
         click.echo(f"Skipping {content_type}/ (no content files found)")
         return
 
-    subprocess.run(
-        ["myst", "start", *ctx.args], cwd=content_path, env=node_env, check=True
+    result = subprocess.run(
+        ["myst", "start", *ctx.args], cwd=content_path, env=node_env, check=False
     )
+    if result.returncode != 0:
+        raise Exit(result.returncode)
 
 
 def _run(ctx):

afterpython/cli/commands/update.py

@@ -9,6 +9,7 @@
 import shutil
 
 import click
+from click.exceptions import Exit
 
 
 @click.group()
@@ -68,8 +69,14 @@ def dependencies(upgrade: bool, all: bool):
         update_dependencies(dependencies)  # write the latest versions to pyproject.toml
         if has_uv():
             click.echo("Upgrading dependencies with uv...")
-            subprocess.run(["uv", "lock"], check=True)
-            subprocess.run(["uv", "sync", "--all-extras", "--all-groups"], check=True)
+            result = subprocess.run(["uv", "lock"], check=False)
+            if result.returncode != 0:
+                raise Exit(result.returncode)
+            result = subprocess.run(
+                ["uv", "sync", "--all-extras", "--all-groups"], check=False
+            )
+            if result.returncode != 0:
+                raise Exit(result.returncode)
             click.echo(
                 click.style(
                     "✓ All dependencies upgraded successfully 🎉", fg="green", bold=True
@@ -80,7 +87,7 @@ def dependencies(upgrade: bool, all: bool):
                 "uv not found. Updated pyproject.toml only (packages not installed)."
             )
     if all:
-        subprocess.run(["ap", "pre-commit", "autoupdate"], check=True)
+        subprocess.run(["ap", "pre-commit", "autoupdate"])
         click.echo("All pre-commit hooks updated successfully.")
 
 
@@ -124,10 +131,18 @@ def website(ctx, no_backup: bool):
     try:
         click.echo("Updating the project website template...")
         node_env: NodeEnv = find_node_env()
-        subprocess.run(
-            ["pnpx", "degit", website_template_repo, str(website_path)], env=node_env
+        result = subprocess.run(
+            ["pnpx", "degit", website_template_repo, str(website_path)],
+            env=node_env,
+            check=False,
+        )
+        if result.returncode != 0:
+            raise Exit(result.returncode)
+        result = subprocess.run(
+            ["pnpm", "install"], cwd=website_path, env=node_env, check=False
         )
-        subprocess.run(["pnpm", "install"], cwd=website_path, env=node_env, check=True)
+        if result.returncode != 0:
+            raise Exit(result.returncode)
     except Exception as e:
         click.echo(f"✗ Error updating project website template: {e}", err=True)
         if not no_backup: