PR feedback

Author: wallstop

.pre-commit-config.yaml

@@ -179,7 +179,7 @@ repos:
         name: check hook output format
         entry: python scripts/hooks/check-hook-output-format.py
         language: python
-        files: '^scripts/hooks/check-.*\.py$'
+        files: '^scripts/(hooks/)?[a-z][^/]*\.py$'
         pass_filenames: true
 
       # ══════════════════════════════════════════════════════════════════════

scripts/check-kani-coverage.py

@@ -222,13 +222,15 @@ def check_unwind_attributes(
         has_errors = True
         print(
             f"\nERROR: {len(errors)} Tier 2/3 proof(s) missing required "
-            f"#[kani::unwind(N)]:"
+            f"#[kani::unwind(N)]:",
+            file=sys.stderr,
         )
         for fn_name, file_path, tier in sorted(errors):
             print(
                 f"  ERROR: Tier {tier} proof '{fn_name}' in file '{file_path}' "
                 f"has no #[kani::unwind(N)]. Tier 2/3 proofs MUST have explicit "
-                f"unwind bounds to prevent CI timeouts."
+                f"unwind bounds to prevent CI timeouts.",
+                file=sys.stderr,
             )
 
     if advisories:
@@ -241,7 +243,8 @@ def check_unwind_attributes(
                 print(
                     f"  WARNING: proof '{fn_name}' in file '{file_path}' has no explicit "
                     f"#[kani::unwind(N)]. CI uses --default-unwind 8; larger data "
-                    f"structures may cause timeouts."
+                    f"structures may cause timeouts.",
+                    file=sys.stderr,
                 )
         else:
             print(
@@ -273,16 +276,16 @@ def main() -> int:
 
     if missing_proofs:
         has_errors = True
-        print("ERROR: The following Kani proofs are NOT in verify-kani.sh:")
+        print("ERROR: The following Kani proofs are NOT in verify-kani.sh:", file=sys.stderr)
         for proof in sorted(missing_proofs):
-            print(f"  - {proof}")
-        print("\nAdd them to one of the TIER*_PROOFS arrays in scripts/verify-kani.sh")
+            print(f"  - {proof}", file=sys.stderr)
+        print("\nAdd them to one of the TIER*_PROOFS arrays in scripts/verify-kani.sh", file=sys.stderr)
 
     if extra_proofs:
         # This is a warning, not an error (could be commented out proofs)
-        print("\nWARNING: The following proofs are in verify-kani.sh but not in source:")
+        print("\nWARNING: The following proofs are in verify-kani.sh but not in source:", file=sys.stderr)
         for proof in sorted(extra_proofs):
-            print(f"  - {proof}")
+            print(f"  - {proof}", file=sys.stderr)
 
     if not has_errors:
         print(f"[OK] All {len(source_proofs)} Kani proofs are covered in verify-kani.sh")

scripts/check-links.py

@@ -297,7 +297,7 @@ def check_markdown_file(
             rel_path = file_path.relative_to(project_root)
         except ValueError:
             rel_path = file_path
-        print(f"ERROR: Could not read {rel_path}: {e}")
+        print(f"ERROR: Could not read {rel_path}: {e}", file=sys.stderr)
         return LinkCheckResult(errors=1, warnings=0, checked=0)
 
     # Find code fence ranges to skip
@@ -331,7 +331,7 @@ def check_markdown_file(
         if not is_valid:
             errors += 1
             rel_path = _rel(file_path, project_root)
-            print(f"ERROR: {rel_path}: {error_msg}")
+            print(f"ERROR: {rel_path}: {error_msg}", file=sys.stderr)
 
     return LinkCheckResult(errors=errors, warnings=warnings, checked=checked)
 

scripts/check-rustdoc-links.py

@@ -54,20 +54,20 @@ def main() -> int:
 
         # If cargo doc failed (non-zero exit code), print stderr and fail
         if result.returncode != 0:
-            print("ERROR: cargo doc failed with rustdoc warnings/errors:")
+            print("ERROR: cargo doc failed with rustdoc warnings/errors:", file=sys.stderr)
             if result.stderr:
-                print(result.stderr)
+                print(result.stderr, file=sys.stderr)
             if result.stdout:
-                print(result.stdout)
+                print(result.stdout, file=sys.stderr)
             return 1
 
         return 0
 
     except FileNotFoundError:
-        print("ERROR: cargo not found. Is Rust installed?")
+        print("ERROR: cargo not found. Is Rust installed?", file=sys.stderr)
         return 1
     except Exception as e:
-        print(f"ERROR: Failed to run cargo doc: {e}")
+        print(f"ERROR: Failed to run cargo doc: {e}", file=sys.stderr)
         return 1
 
 

scripts/check-wiki-consistency.py

@@ -116,7 +116,7 @@ def parse_wiki_structure_from_sync_script(sync_script_path: Path) -> dict[str, s
                                     result[str(key.value)] = str(value.value)
                             return result
     except (OSError, SyntaxError) as e:
-        print(red(f"ERROR: Could not parse {sync_script_path}: {e}"))
+        print(red(f"ERROR: Could not parse {sync_script_path}: {e}"), file=sys.stderr)
 
     return {}
 
@@ -156,7 +156,7 @@ def parse_hardcoded_sidebar_from_sync_script(sync_script_path: Path) -> str | No
                                 if isinstance(stmt.value, ast.Constant):
                                     return str(stmt.value.value)
     except (OSError, SyntaxError) as e:
-        print(red(f"ERROR: Could not parse {sync_script_path}: {e}"))
+        print(red(f"ERROR: Could not parse {sync_script_path}: {e}"), file=sys.stderr)
 
     return None
 
@@ -272,7 +272,8 @@ def validate_sync_script_sidebar_template(
         errors += 1
         print(
             red("ERROR:")
-            + f" Could not extract hardcoded sidebar template from {sync_script_path}"
+            + f" Could not extract hardcoded sidebar template from {sync_script_path}",
+            file=sys.stderr,
         )
         return ValidationResult(errors=errors, warnings=warnings)
 
@@ -302,7 +303,8 @@ def validate_sync_script_sidebar_template(
                     + f" {sync_script_path.name}:generate_sidebar(): "
                     + f"Wiki-link [[{page_name}|{display_text}]] "
                     + f"contains '{char}' in display text ({reason}). "
-                    + f"Use standard markdown [Display](Page) syntax instead."
+                    + f"Use standard markdown [Display](Page) syntax instead.",
+                    file=sys.stderr,
                 )
                 break  # Only report first problematic character per link
 
@@ -367,7 +369,7 @@ def parse_sidebar_wiki_links(
         content = sidebar_path.read_text(encoding="utf-8")
         return parse_wiki_links_from_string(content)
     except (OSError, UnicodeDecodeError) as e:
-        print(red(f"ERROR: Could not read {sidebar_path}: {e}"))
+        print(red(f"ERROR: Could not read {sidebar_path}: {e}"), file=sys.stderr)
         return []
 
 
@@ -433,7 +435,8 @@ def validate_wiki_link_display_text(
                     red("ERROR:")
                     + f" _Sidebar.md:{line_num}: Wiki-link [[{page_name}|{display_text}]] "
                     + f"contains '{char}' in display text ({reason}). "
-                    + f"Use standard markdown [Display](Page) syntax instead."
+                    + f"Use standard markdown [Display](Page) syntax instead.",
+                    file=sys.stderr,
                 )
                 break  # Only report first problematic character per link
 
@@ -463,7 +466,8 @@ def validate_sidebar_links(
             print(
                 red("ERROR:")
                 + f" _Sidebar.md:{line_num}: Link to '{page_name}' "
-                + f"points to non-existent page '{page_name}.md'"
+                + f"points to non-existent page '{page_name}.md'",
+                file=sys.stderr,
             )
         elif verbose:
             syntax_label = "wiki" if syntax_type == "wiki" else "md"
@@ -495,7 +499,8 @@ def validate_wiki_structure_completeness(
             print(
                 yellow("WARNING:")
                 + f" docs/{unmapped} has no mapping in WIKI_STRUCTURE "
-                + "(scripts/sync-wiki.py)"
+                + "(scripts/sync-wiki.py)",
+                file=sys.stderr,
             )
 
     # Also check for stale mappings (mapped files that no longer exist)
@@ -506,7 +511,8 @@ def validate_wiki_structure_completeness(
         print(
             yellow("WARNING:")
             + f" WIKI_STRUCTURE contains mapping for '{stale}' "
-            + "which does not exist in docs/"
+            + "which does not exist in docs/",
+            file=sys.stderr,
         )
 
     return ValidationResult(errors=errors, warnings=warnings)
@@ -546,7 +552,8 @@ def validate_sidebar_completeness(
             warnings += 1
             print(
                 yellow("WARNING:")
-                + f" Wiki page '{missing}.md' has no entry in _Sidebar.md"
+                + f" Wiki page '{missing}.md' has no entry in _Sidebar.md",
+                file=sys.stderr,
             )
 
     return ValidationResult(errors=errors, warnings=warnings)
@@ -632,17 +639,19 @@ def validate_table_pipe_escaping(
                         print(
                             red("ERROR:")
                             + f" {md_file.name}:{line_num}: Table cell contains "
-                            + f"unescaped pipe in code span: `{code_content}`"
+                            + f"unescaped pipe in code span: `{code_content}`",
+                            file=sys.stderr,
                         )
                         print(
                             "       "
                             + yellow("Tip:")
                             + " Escape the pipe with backslash: "
-                            + f"`{code_content.replace('|', chr(92) + '|')}`"
+                            + f"`{code_content.replace('|', chr(92) + '|')}`",
+                            file=sys.stderr,
                         )
 
         except (OSError, UnicodeDecodeError) as e:
-            print(red(f"ERROR: Could not read {md_file}: {e}"))
+            print(red(f"ERROR: Could not read {md_file}: {e}"), file=sys.stderr)
             errors += 1
 
     return ValidationResult(errors=errors, warnings=warnings)
@@ -682,7 +691,8 @@ def validate_markdown_link_syntax(wiki_dir: Path, verbose: bool = False) -> Vali
                     print(
                         red("ERROR:")
                         + f" {md_file.name}:{line_num}: Malformed link with space "
-                        + f"after '[': {match.group()}"
+                        + f"after '[': {match.group()}",
+                        file=sys.stderr,
                     )
 
                 # Check for space before closing bracket
@@ -691,7 +701,8 @@ def validate_markdown_link_syntax(wiki_dir: Path, verbose: bool = False) -> Vali
                     print(
                         yellow("WARNING:")
                         + f" {md_file.name}:{line_num}: Link has trailing space "
-                        + f"before ']': {match.group()}"
+                        + f"before ']': {match.group()}",
+                        file=sys.stderr,
                     )
 
                 # Check for empty link text
@@ -700,11 +711,12 @@ def validate_markdown_link_syntax(wiki_dir: Path, verbose: bool = False) -> Vali
                     print(
                         yellow("WARNING:")
                         + f" {md_file.name}:{line_num}: Empty link text: "
-                        + f"{match.group()}"
+                        + f"{match.group()}",
+                        file=sys.stderr,
                     )
 
         except (OSError, UnicodeDecodeError) as e:
-            print(red(f"ERROR: Could not read {md_file}: {e}"))
+            print(red(f"ERROR: Could not read {md_file}: {e}"), file=sys.stderr)
             errors += 1
 
     return ValidationResult(errors=errors, warnings=warnings)
@@ -730,15 +742,15 @@ def main() -> int:
 
     # Check required files/directories exist
     if not wiki_dir.exists():
-        print(red("ERROR:") + f" Wiki directory not found: {wiki_dir}")
+        print(red("ERROR:") + f" Wiki directory not found: {wiki_dir}", file=sys.stderr)
         return 1
 
     if not sidebar_path.exists():
-        print(red("ERROR:") + f" Sidebar not found: {sidebar_path}")
+        print(red("ERROR:") + f" Sidebar not found: {sidebar_path}", file=sys.stderr)
         return 1
 
     if not sync_script_path.exists():
-        print(red("ERROR:") + f" Sync script not found: {sync_script_path}")
+        print(red("ERROR:") + f" Sync script not found: {sync_script_path}", file=sys.stderr)
         return 1
 
     # Get wiki pages and parse WIKI_STRUCTURE
@@ -747,7 +759,7 @@ def main() -> int:
     docs_files = get_docs_source_files(docs_dir)
 
     if not wiki_structure:
-        print(red("ERROR:") + " Could not parse WIKI_STRUCTURE from sync-wiki.py")
+        print(red("ERROR:") + " Could not parse WIKI_STRUCTURE from sync-wiki.py", file=sys.stderr)
         return 1
 
     if verbose:

scripts/hooks/check-hook-output-format.py

@@ -10,6 +10,7 @@
 - No raw path variables in error output when file uses glob/rglob/iterdir
   (absolute paths break {path}:{line}: parsing on Windows due to drive letter
   colons -- use relative_to() or a display_path variable instead)
+- No ERROR:/WARNING: diagnostic prints going to stdout (must use file=sys.stderr)
 
 Cross-platform: Works on Linux, macOS, and Windows.
 """
@@ -152,6 +153,65 @@ def check_file(filepath: Path, repo_root: Path | None = None) -> list[str]:
                     # logic -- stop looking
                     break
 
+        # Check 7: ERROR/WARNING prints going to stdout instead of stderr
+        # Detect print() calls containing ERROR: or WARNING: diagnostic
+        # prefixes that do not include file=sys.stderr.  These messages
+        # must go to stderr per project conventions.
+        #
+        # Handles both single-line and multi-line cases:
+        #   Single-line:  print("ERROR: something")
+        #   Multi-line:   print(
+        #                     f"  WARNING: proof ..."
+        #                 )
+        # For multi-line, we check if we're inside an open print() call
+        # (tracked by in_print_call) and look for ERROR:/WARNING: on
+        # continuation lines.
+        if re.search(
+            r"""print\(.*(?:ERROR|WARNING)\s*:""", stripped
+        ) and "file=sys.stderr" not in stripped:
+            issues.append(
+                f"{display_path}:{line_num}: print() with ERROR:/WARNING: diagnostic goes to stdout -- add file=sys.stderr"
+            )
+
+    # Check 7b: Multi-line print() calls with ERROR:/WARNING: on
+    # continuation lines.  Walk the file a second time, tracking open
+    # print( calls and scanning their bodies for diagnostic prefixes.
+    in_print = False
+    print_start_line = 0
+    print_lines: list[str] = []
+    paren_depth = 0
+    for line_num, line in enumerate(lines, start=1):
+        stripped = line.strip()
+        if stripped.startswith("#") or not stripped:
+            if in_print:
+                # accumulate even blank/comment lines inside a print call
+                print_lines.append(stripped)
+            continue
+
+        if not in_print:
+            # Detect start of a print( call
+            if re.match(r"print\(", stripped):
+                in_print = True
+                print_start_line = line_num
+                print_lines = [stripped]
+                paren_depth = stripped.count("(") - stripped.count(")")
+                if paren_depth <= 0:
+                    # Single-line — already handled by Check 7 above
+                    in_print = False
+        else:
+            print_lines.append(stripped)
+            paren_depth += stripped.count("(") - stripped.count(")")
+            if paren_depth <= 0:
+                # End of multi-line print call — analyse the joined body
+                joined = " ".join(print_lines)
+                has_diag = re.search(r"(?:ERROR|WARNING)\s*:", joined)
+                has_stderr = "file=sys.stderr" in joined
+                if has_diag and not has_stderr:
+                    issues.append(
+                        f"{display_path}:{print_start_line}: multi-line print() with ERROR:/WARNING: diagnostic goes to stdout -- add file=sys.stderr"
+                    )
+                in_print = False
+
     # Check 6: Raw path variables in error output when file uses glob/rglob
     # When a script discovers files via glob(), rglob(), or iterdir(), the
     # resulting Path objects are absolute. Using them directly in error

scripts/run-cargo-clippy.py

@@ -34,16 +34,16 @@ def main() -> int:
         )
 
         if result.returncode != 0:
-            print("\nERROR: Clippy found issues. Fix the warnings above.")
+            print("\nERROR: Clippy found issues. Fix the warnings above.", file=sys.stderr)
 
         return result.returncode
 
     except FileNotFoundError:
-        print("ERROR: cargo not found. Is Rust installed?")
-        print("  Install from: https://rustup.rs/")
+        print("ERROR: cargo not found. Is Rust installed?", file=sys.stderr)
+        print("  Install from: https://rustup.rs/", file=sys.stderr)
         return 1
     except Exception as e:
-        print(f"ERROR: Failed to run cargo clippy: {e}")
+        print(f"ERROR: Failed to run cargo clippy: {e}", file=sys.stderr)
         return 1