debugbrief 1.1.0__tar.gz → 1.2.0__tar.gz

{debugbrief-1.1.0/src/debugbrief.egg-info → debugbrief-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: debugbrief
-Version: 1.1.0
+Version: 1.2.0
 Summary: Local-first CLI that records the meaningful context of a debugging session and turns it into a useful markdown brief.
 Author: DebugBrief
 License-Expression: MIT
@@ -30,7 +30,9 @@ Dynamic: license-file
 
 # DebugBrief
 
-[![CI](https://github.com/harihkk/Debug-Brief/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/harihkk/Debug-Brief/actions/workflows/ci.yml) [![PyPI](https://img.shields.io/pypi/v/debugbrief)](https://pypi.org/project/debugbrief/)
+[![CI](https://github.com/harihkk/Debug-Brief/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/harihkk/Debug-Brief/actions/workflows/ci.yml) [![PyPI](https://img.shields.io/pypi/v/debugbrief?cacheSeconds=3600)](https://pypi.org/project/debugbrief/)
+
+![A failing test streams live, the fix lands, redo passes, and the generated brief appears](https://raw.githubusercontent.com/harihkk/Debug-Brief/main/docs/demo.gif)
 
 Turn a debugging session into an honest markdown brief for a PR, a handoff, or an
 incident note.
@@ -91,11 +93,19 @@ The resulting report leads with a derived one-liner like:
   and a per-command git snapshot, then returns the command's own exit code.
 - Pass/fail comes only from the exit code. A command counts as "verified" only if
   a recognized test/build/lint/typecheck command actually exited `0`.
+- Recognized runners include pytest, unittest, tox, vitest, jest, bun test,
+  deno test, node --test, npm/pnpm/yarn test, go test, cargo test, make
+  test/check, dotnet test, ctest, phpunit, mix test, swift test, rspec, and
+  mvn/gradle test. For custom scripts, declare the check yourself:
+  `debugbrief run --verify -- ./scripts/test.sh`.
 - `end` derives the report from those events: the red-to-green window, the
   reproduce/verify commands, a timeline, the observed error verbatim, and what
   was ruled out. Empty sections are omitted, never padded.
-- Secret-like values in captured output are replaced with `[redacted]` before
-  anything is written to disk (best effort; `--no-redact` opts out).
+- Redaction runs before anything reaches disk and catches common shapes:
+  sensitive `name=value` pairs, bearer and authorization headers, OpenAI/AWS/
+  GitHub style keys, connection-string passwords, and PEM private key blocks,
+  each replaced with `[redacted]`. Best effort by design; `--no-redact` opts
+  out per command.
 
 ## Commands
 
@@ -105,6 +115,7 @@ The resulting report leads with a derived one-liner like:
 | `note <text ...>` | Record a note (quoting optional) |
 | `run -- <command ...>` | Execute and capture a command |
 | `redo` | Re-run the last captured command |
+| `preview [--mode ...]` | Print the report without ending the session |
 | `end [--mode pr\|handoff\|incident]` | Finalize and write a report (default `pr`) |
 | `cancel [--yes]` | Discard the active session, no report |
 | `status` | Show the active session |

{debugbrief-1.1.0 → debugbrief-1.2.0}/README.md

@@ -1,6 +1,8 @@
 # DebugBrief
 
-[![CI](https://github.com/harihkk/Debug-Brief/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/harihkk/Debug-Brief/actions/workflows/ci.yml) [![PyPI](https://img.shields.io/pypi/v/debugbrief)](https://pypi.org/project/debugbrief/)
+[![CI](https://github.com/harihkk/Debug-Brief/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/harihkk/Debug-Brief/actions/workflows/ci.yml) [![PyPI](https://img.shields.io/pypi/v/debugbrief?cacheSeconds=3600)](https://pypi.org/project/debugbrief/)
+
+![A failing test streams live, the fix lands, redo passes, and the generated brief appears](https://raw.githubusercontent.com/harihkk/Debug-Brief/main/docs/demo.gif)
 
 Turn a debugging session into an honest markdown brief for a PR, a handoff, or an
 incident note.
@@ -61,11 +63,19 @@ The resulting report leads with a derived one-liner like:
   and a per-command git snapshot, then returns the command's own exit code.
 - Pass/fail comes only from the exit code. A command counts as "verified" only if
   a recognized test/build/lint/typecheck command actually exited `0`.
+- Recognized runners include pytest, unittest, tox, vitest, jest, bun test,
+  deno test, node --test, npm/pnpm/yarn test, go test, cargo test, make
+  test/check, dotnet test, ctest, phpunit, mix test, swift test, rspec, and
+  mvn/gradle test. For custom scripts, declare the check yourself:
+  `debugbrief run --verify -- ./scripts/test.sh`.
 - `end` derives the report from those events: the red-to-green window, the
   reproduce/verify commands, a timeline, the observed error verbatim, and what
   was ruled out. Empty sections are omitted, never padded.
-- Secret-like values in captured output are replaced with `[redacted]` before
-  anything is written to disk (best effort; `--no-redact` opts out).
+- Redaction runs before anything reaches disk and catches common shapes:
+  sensitive `name=value` pairs, bearer and authorization headers, OpenAI/AWS/
+  GitHub style keys, connection-string passwords, and PEM private key blocks,
+  each replaced with `[redacted]`. Best effort by design; `--no-redact` opts
+  out per command.
 
 ## Commands
 
@@ -75,6 +85,7 @@ The resulting report leads with a derived one-liner like:
 | `note <text ...>` | Record a note (quoting optional) |
 | `run -- <command ...>` | Execute and capture a command |
 | `redo` | Re-run the last captured command |
+| `preview [--mode ...]` | Print the report without ending the session |
 | `end [--mode pr\|handoff\|incident]` | Finalize and write a report (default `pr`) |
 | `cancel [--yes]` | Discard the active session, no report |
 | `status` | Show the active session |

{debugbrief-1.1.0 → debugbrief-1.2.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "debugbrief"
-version = "1.1.0"
+version = "1.2.0"
 description = "Local-first CLI that records the meaningful context of a debugging session and turns it into a useful markdown brief."
 readme = "README.md"
 requires-python = ">=3.9"

{debugbrief-1.1.0 → debugbrief-1.2.0}/src/debugbrief/__init__.py

@@ -8,6 +8,6 @@ It uses only the Python standard library and native ``git``. No AI, no
 telemetry, no cloud sync, no background daemon.
 """
 
-__version__ = "1.1.0"
+__version__ = "1.2.0"
 
 __all__ = ["__version__"]

{debugbrief-1.1.0 → debugbrief-1.2.0}/src/debugbrief/cli.py

@@ -5,7 +5,8 @@ Commands:
     debugbrief note  <text ...>
     debugbrief run   [--shell] [--timeout N] [--no-redact] -- <command ...>
     debugbrief run   "<command>"
-    debugbrief redo  [--timeout N] [--no-redact]
+    debugbrief redo  [--timeout N] [--no-redact] [--verify]
+    debugbrief preview [--mode pr|handoff|incident]
     debugbrief end   [--mode pr|handoff|incident] [--format md|json|both] [--stdout]
     debugbrief cancel [--yes]
     debugbrief status
@@ -117,6 +118,15 @@ def build_parser() -> argparse.ArgumentParser:
             "redaction. Use only when you know the output is safe."
         ),
     )
+    p_run.add_argument(
+        "--verify",
+        action="store_true",
+        help=(
+            "Declare this command a check (custom test script, make "
+            "integration). It counts as verification when it exits 0; a "
+            "recognized test runner is classified automatically and wins."
+        ),
+    )
     p_run.add_argument(
         "command",
         nargs=argparse.REMAINDER,
@@ -147,8 +157,29 @@ def build_parser() -> argparse.ArgumentParser:
         action="store_true",
         help="Store captured output verbatim, without secret redaction.",
     )
+    p_redo.add_argument(
+        "--verify",
+        action="store_true",
+        help=(
+            "Declare the re-run a check (see run --verify). Inherited "
+            "automatically when the original run was declared with --verify."
+        ),
+    )
     p_redo.set_defaults(func=cmd_redo)
 
+    # preview ------------------------------------------------------------
+    p_preview = subparsers.add_parser(
+        "preview",
+        help="Print the report for the active session without ending it.",
+    )
+    p_preview.add_argument(
+        "--mode",
+        default="pr",
+        choices=VALID_MODES,
+        help="Report style to preview (default pr).",
+    )
+    p_preview.set_defaults(func=cmd_preview)
+
     # end ----------------------------------------------------------------
     p_end = subparsers.add_parser(
         "end", help="Finalize the session and write a markdown report."
@@ -373,6 +404,7 @@ def cmd_run(args: argparse.Namespace) -> int:
         use_shell=args.shell,
         timeout_seconds=args.timeout,
         redact=not args.no_redact,
+        force_verification=args.verify,
     )
     manager.record_command(result)
     _print_command_outcome(result, args.timeout)
@@ -433,6 +465,10 @@ def cmd_redo(args: argparse.Namespace) -> int:
         )
         return 1
 
+    # A redo of a command originally declared with --verify stays a declared
+    # check without retyping the flag; an explicit --verify also works.
+    inherit_verify = last.classification.tool == "custom"
+
     eprint(f"$ {last.command}  (redo)")
     result = run_command(
         command=last.command,
@@ -440,6 +476,7 @@ def cmd_redo(args: argparse.Namespace) -> int:
         use_shell=last.used_shell,
         timeout_seconds=args.timeout,
         redact=not args.no_redact,
+        force_verification=args.verify or inherit_verify,
     )
     manager.record_command(result)
     _print_command_outcome(result, args.timeout)
@@ -469,6 +506,19 @@ def cmd_end(args: argparse.Namespace) -> int:
     return 0
 
 
+def cmd_preview(args: argparse.Namespace) -> int:
+    manager = _manager()
+    markdown = manager.preview(args.mode)
+    banner = "_Preview of an active session. Run debugbrief end to finalize._"
+    lines = markdown.splitlines()
+    if lines and lines[0].startswith("# "):
+        rendered = lines[0] + "\n\n" + banner + "\n" + "\n".join(lines[1:]) + "\n"
+    else:  # pragma: no cover - reports always start with a title
+        rendered = banner + "\n\n" + markdown
+    sys.stdout.write(rendered)
+    return 0
+
+
 def cmd_cancel(args: argparse.Namespace) -> int:
     manager = _manager()
     session = manager.load_active()

{debugbrief-1.1.0 → debugbrief-1.2.0}/src/debugbrief/command_runner.py

@@ -87,6 +87,7 @@ def run_command(
     stderr_limit: int = DEFAULT_STDERR_PREVIEW_LIMIT,
     redact: bool = True,
     echo: bool = True,
+    force_verification: bool = False,
 ) -> RunResult:
     """Run ``command`` from ``cwd`` and capture a :class:`CommandData`.
 
@@ -101,6 +102,9 @@ def run_command(
     By default captured output and the command string are passed through
     best-effort secret redaction before they are returned, so raw secrets never
     reach the session file. Pass ``redact=False`` to store the raw text.
+
+    ``force_verification`` marks an unrecognized command as a declared check
+    (tool ``custom``); pass/fail honesty is unaffected.
     """
     started_at = now_iso8601()
     start_monotonic = time.monotonic()
@@ -200,6 +204,7 @@ def run_command(
         exit_code=exit_code,
         timed_out=timed_out,
         errored=errored,
+        force_verification=force_verification,
     )
 
     stored_command = command

{debugbrief-1.1.0 → debugbrief-1.2.0}/src/debugbrief/filters.py

@@ -47,6 +47,19 @@ _TEST_PATTERNS: List[Tuple[List[str], str]] = [
     (["mvn", "test"], "maven"),
     (["gradle", "test"], "gradle"),
     (["./gradlew", "test"], "gradle"),
+    (["vitest"], "vitest"),
+    (["bun", "test"], "bun"),
+    (["deno", "test"], "deno"),
+    (["node", "--test"], "node"),
+    (["make", "test"], "make"),
+    (["make", "check"], "make"),
+    (["tox"], "tox"),
+    (["unittest"], "unittest"),
+    (["dotnet", "test"], "dotnet"),
+    (["ctest"], "ctest"),
+    (["phpunit"], "phpunit"),
+    (["mix", "test"], "mix"),
+    (["swift", "test"], "swift"),
 ]
 
 # (pattern_tokens, tool, category) for build/lint/typecheck detection.
@@ -120,12 +133,18 @@ def classify_command(
     exit_code: Optional[int],
     timed_out: bool = False,
     errored: bool = False,
+    force_verification: bool = False,
 ) -> CommandClassification:
     """Classify a command into test / verification categories.
 
     A command is verification-worthy only if it is a recognized test command
     that exited 0, or a recognized build/lint/typecheck command that exited 0.
     Pass/fail is derived strictly from the real exit code.
+
+    ``force_verification`` lets the user declare an unrecognized command (a
+    custom test script, ``make integration``) as a check. It applies only when
+    no pattern matched; a recognized runner always wins. The honesty rule is
+    unchanged: ``is_verification`` is True only on a real exit 0.
     """
     tokens = _tokenize(command)
     status = status_from_outcome(exit_code, timed_out, errored)
@@ -150,6 +169,14 @@ def classify_command(
             status=status,
         )
 
+    if force_verification:
+        return CommandClassification(
+            is_test=False,
+            is_verification=passed,
+            tool="custom",
+            status=status,
+        )
+
     return CommandClassification(
         is_test=False,
         is_verification=False,

{debugbrief-1.1.0 → debugbrief-1.2.0}/src/debugbrief/session_manager.py

@@ -263,6 +263,20 @@ class SessionManager:
         self._clear_active_pointer()
         return session
 
+    def preview(self, mode: str) -> str:
+        """Render a report for the active session without mutating anything.
+
+        Works on a deep copy (via the dict round trip), so the live session
+        keeps its status, timestamps, and file exactly as they are; no report
+        file is written. The summary is finalized on the copy only.
+        """
+        from .reporters import render_report  # local import avoids a cycle
+
+        session = self.require_active("preview the report")
+        copy = Session.from_dict(session.to_dict())
+        self._finalize_summary(copy)
+        return render_report(copy, mode)
+
     def cancel(self) -> Session:
         """Discard the active session without writing a report.
 

{debugbrief-1.1.0 → debugbrief-1.2.0/src/debugbrief.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: debugbrief
-Version: 1.1.0
+Version: 1.2.0
 Summary: Local-first CLI that records the meaningful context of a debugging session and turns it into a useful markdown brief.
 Author: DebugBrief
 License-Expression: MIT
@@ -30,7 +30,9 @@ Dynamic: license-file
 
 # DebugBrief
 
-[![CI](https://github.com/harihkk/Debug-Brief/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/harihkk/Debug-Brief/actions/workflows/ci.yml) [![PyPI](https://img.shields.io/pypi/v/debugbrief)](https://pypi.org/project/debugbrief/)
+[![CI](https://github.com/harihkk/Debug-Brief/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/harihkk/Debug-Brief/actions/workflows/ci.yml) [![PyPI](https://img.shields.io/pypi/v/debugbrief?cacheSeconds=3600)](https://pypi.org/project/debugbrief/)
+
+![A failing test streams live, the fix lands, redo passes, and the generated brief appears](https://raw.githubusercontent.com/harihkk/Debug-Brief/main/docs/demo.gif)
 
 Turn a debugging session into an honest markdown brief for a PR, a handoff, or an
 incident note.
@@ -91,11 +93,19 @@ The resulting report leads with a derived one-liner like:
   and a per-command git snapshot, then returns the command's own exit code.
 - Pass/fail comes only from the exit code. A command counts as "verified" only if
   a recognized test/build/lint/typecheck command actually exited `0`.
+- Recognized runners include pytest, unittest, tox, vitest, jest, bun test,
+  deno test, node --test, npm/pnpm/yarn test, go test, cargo test, make
+  test/check, dotnet test, ctest, phpunit, mix test, swift test, rspec, and
+  mvn/gradle test. For custom scripts, declare the check yourself:
+  `debugbrief run --verify -- ./scripts/test.sh`.
 - `end` derives the report from those events: the red-to-green window, the
   reproduce/verify commands, a timeline, the observed error verbatim, and what
   was ruled out. Empty sections are omitted, never padded.
-- Secret-like values in captured output are replaced with `[redacted]` before
-  anything is written to disk (best effort; `--no-redact` opts out).
+- Redaction runs before anything reaches disk and catches common shapes:
+  sensitive `name=value` pairs, bearer and authorization headers, OpenAI/AWS/
+  GitHub style keys, connection-string passwords, and PEM private key blocks,
+  each replaced with `[redacted]`. Best effort by design; `--no-redact` opts
+  out per command.
 
 ## Commands
 
@@ -105,6 +115,7 @@ The resulting report leads with a derived one-liner like:
 | `note <text ...>` | Record a note (quoting optional) |
 | `run -- <command ...>` | Execute and capture a command |
 | `redo` | Re-run the last captured command |
+| `preview [--mode ...]` | Print the report without ending the session |
 | `end [--mode pr\|handoff\|incident]` | Finalize and write a report (default `pr`) |
 | `cancel [--yes]` | Discard the active session, no report |
 | `status` | Show the active session |

{debugbrief-1.1.0 → debugbrief-1.2.0}/src/debugbrief.egg-info/SOURCES.txt

@@ -46,4 +46,5 @@ tests/test_reporters.py
 tests/test_run_passthrough.py
 tests/test_session_lifecycle.py
 tests/test_snapshots.py
-tests/test_utils.py
+tests/test_utils.py
+tests/test_v12_features.py

{debugbrief-1.1.0 → debugbrief-1.2.0}/tests/test_autostart.py

@@ -48,6 +48,7 @@ def test_run_autostarts_session(paths, capsys):
             shell=False,
             timeout=30,
             no_redact=False,
+            verify=False,
         )
     )
     assert rc == 0

debugbrief-1.2.0/tests/test_v12_features.py

@@ -0,0 +1,154 @@
+"""Tests for the expanded runner table, --verify, and preview."""
+
+from __future__ import annotations
+
+import sys
+
+import pytest
+
+from debugbrief import cli, filters
+from debugbrief.paths import ProjectPaths
+from debugbrief.session_manager import SessionManager
+
+PY = sys.executable
+
+
+@pytest.fixture
+def paths(tmp_path):
+    return ProjectPaths(project_root=tmp_path, is_git_repo=False, repo_root=None)
+
+
+@pytest.fixture(autouse=True)
+def _patch_resolve(monkeypatch, paths):
+    monkeypatch.setattr(cli, "resolve_project_paths", lambda: paths)
+    return paths
+
+
+# Expanded runner table -------------------------------------------------------
+@pytest.mark.parametrize(
+    ("command", "tool"),
+    [
+        ("vitest run", "vitest"),
+        ("npx vitest", "vitest"),
+        ("bun test", "bun"),
+        ("deno test --allow-read", "deno"),
+        ("node --test tests/", "node"),
+        ("make test", "make"),
+        ("make check", "make"),
+        ("tox -e py311", "tox"),
+        ("python -m unittest discover", "unittest"),
+        ("dotnet test", "dotnet"),
+        ("ctest --output-on-failure", "ctest"),
+        ("phpunit tests/", "phpunit"),
+        ("mix test", "mix"),
+        ("swift test", "swift"),
+    ],
+)
+def test_new_runners_classified(command, tool):
+    passing = filters.classify_command(command, exit_code=0)
+    assert passing.is_test is True, command
+    assert passing.tool == tool, command
+    assert passing.is_verification is True, command
+
+    failing = filters.classify_command(command, exit_code=1)
+    assert failing.is_test is True, command
+    assert failing.tool == tool, command
+    assert failing.is_verification is False, command
+
+
+@pytest.mark.parametrize("command", ["make build", "bun install", "deno run app.ts"])
+def test_non_test_invocations_not_classified(command):
+    cls = filters.classify_command(command, exit_code=0)
+    assert cls.is_test is False, command
+    assert cls.tool is None or cls.tool not in ("make", "bun", "deno"), command
+
+
+# --verify --------------------------------------------------------------------
+def test_verify_marks_custom_command_as_check():
+    cls = filters.classify_command(
+        "./scripts/integration.sh", exit_code=0, force_verification=True
+    )
+    assert cls.tool == "custom"
+    assert cls.is_test is False
+    assert cls.is_verification is True
+
+
+def test_verify_failure_stays_honest():
+    cls = filters.classify_command(
+        "./scripts/integration.sh", exit_code=1, force_verification=True
+    )
+    assert cls.tool == "custom"
+    assert cls.is_verification is False
+
+
+def test_verify_is_noop_on_recognized_runner():
+    cls = filters.classify_command("pytest -q", exit_code=0, force_verification=True)
+    assert cls.tool == "pytest"
+    assert cls.is_test is True
+
+
+def test_verify_enables_red_to_green_for_custom_check(paths):
+    # A custom script fails, then passes: with --verify both runs are
+    # verification candidates, so the report derives reproduce/verify lines.
+    script = paths.project_root / "check.sh"
+    script.write_text("#!/bin/sh\nexit $(cat flag)\n", encoding="utf-8")
+    script.chmod(0o755)
+    flag = paths.project_root / "flag"
+
+    flag.write_text("1", encoding="utf-8")
+    assert cli.main(["run", "--verify", "--", "./check.sh"]) == 1
+    flag.write_text("0", encoding="utf-8")
+    assert cli.main(["run", "--verify", "--", "./check.sh"]) == 0
+
+    report = SessionManager(paths).preview("pr")
+    assert "Reproduce (failed): `./check.sh`" in report
+    assert "Verify (passed): `./check.sh`" in report
+
+
+def test_redo_inherits_verify(paths):
+    (paths.project_root / "ok.sh").write_text("#!/bin/sh\nexit 0\n", encoding="utf-8")
+    (paths.project_root / "ok.sh").chmod(0o755)
+    assert cli.main(["run", "--verify", "--", "./ok.sh"]) == 0
+    assert cli.main(["redo"]) == 0
+
+    events = SessionManager(paths).load_active().command_events()
+    assert len(events) == 2
+    assert events[1].data["classification"]["tool"] == "custom"
+    assert events[1].data["classification"]["is_verification"] is True
+
+
+# preview ---------------------------------------------------------------------
+def test_preview_renders_without_mutating(paths, capsys):
+    manager = SessionManager(paths)
+    session = manager.start("preview me")
+    manager.add_note("an observation")
+    before = paths.session_file(session.session_id).read_bytes()
+    capsys.readouterr()
+
+    rc = cli.main(["preview"])
+    assert rc == 0
+    out = capsys.readouterr().out
+    assert out.startswith("# preview me")
+    assert "Preview of an active session" in out
+    assert "an observation" in out
+
+    # Nothing changed on disk: session byte-identical, no reports written.
+    assert paths.session_file(session.session_id).read_bytes() == before
+    assert manager.load_active().status == "ACTIVE"
+    assert not paths.reports_dir.exists() or not list(paths.reports_dir.glob("*"))
+
+
+def test_preview_mid_session_with_commands(paths, capsys):
+    cli.main(["run", "--", PY, "-c", "print(42)"])
+    capsys.readouterr()
+    rc = cli.main(["preview", "--mode", "incident"])
+    assert rc == 0
+    out = capsys.readouterr().out
+    assert "Preview of an active session" in out
+    assert "print(42)" in out
+
+
+def test_preview_without_session_errors(paths, capsys):
+    rc = cli.main(["preview"])
+    assert rc == 1
+    assert "No active DebugBrief session" in capsys.readouterr().err