feat: remove status messages and make --debug require --verbose by dreamiurg · Pull Request #11 · dreamiurg/peakbagger-cli

dreamiurg · 2025-10-24T00:35:24Z

Summary

Removes all status messages like "Fetching peak ###" from CLI output
Makes --debug flag require --verbose flag
CLI is now silent by default except for data output and errors

Changes

✅ Remove all _status() calls and the unused function
✅ Add validation requiring --verbose flag when using --debug
✅ Update --debug help text to indicate it requires --verbose
✅ Update CLAUDE.md logging guidelines
✅ Update README.md sample outputs to remove status messages
✅ Fix mypy type errors in date filter code

Behavior

Before:

$ peakbagger peak show 2296
Fetching peak 2296...
[peak data displayed]

After:

$ peakbagger peak show 2296
[peak data displayed - no status messages]

$ peakbagger --verbose peak show 2296
[INFO logs on stderr] + [peak data on stdout]

$ peakbagger --verbose --debug peak show 2296
[DEBUG + INFO logs on stderr] + [peak data on stdout]

Test plan

Tested default output has no status messages
Tested --verbose shows INFO logs
Tested --verbose --debug shows DEBUG logs
Tested --debug without --verbose shows error
Tested JSON output remains clean
All pre-commit hooks pass
mypy type checking passes

🤖 Generated with Claude Code

Summary by CodeRabbit

Documentation
- Updated to reflect main branch as primary for releases and commits; clarified verbose and debug logging modes.
Changes
- CLI is now silent by default, showing only errors and results; --debug now requires --verbose flag.

Removes all status messages like "Fetching peak ###" from CLI output. CLI is now silent by default except for data output and errors. Changes: - Remove all _status() calls and the function itself - Add validation requiring --verbose flag when using --debug - Update --debug help text to indicate it requires --verbose - Update CLAUDE.md logging guidelines and documentation - Update README.md sample outputs to remove status messages - Fix mypy type errors in date filter code Users who want logging should use --verbose for INFO logs or --verbose --debug for DEBUG logs. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

coderabbitai · 2025-10-24T00:35:35Z

Walkthrough

This PR migrates the project from dual master/main branch support to main-only, updates logging to be silent by default with new --debug/--verbose guidelines, and removes status message functions from the CLI to suppress progress output during execution.

Changes

Cohort / File(s)	Summary
Branch Configuration Migration `.github/workflows/release.yml`, `.pre-commit-config.yaml`, `.releaserc.json`	Removes master branch references, restricting release and commit workflows to main branch only across CI/CD and semantic-release configurations.
Documentation Updates `CLAUDE.md`, `README.md`	Updates setup and release workflow documentation to reflect main-only branch usage; adds logging guidelines detailing silent-by-default behavior, --verbose (INFO level), and --debug (requires --verbose, enables DEBUG level); removes sample output lines showing progress messages.
CLI Refactoring `peakbagger/cli.py`	Removes module-level `_status` helper function and all status message calls across commands (search, show, ascents, stats, show_ascent); adds runtime validation requiring --verbose when --debug is used; updates date-filter variable handling with explicit type annotations.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

The changes span multiple file types with mixed complexity: configuration updates are straightforward (branch reference removals), documentation is largely descriptive, but the CLI refactoring involves logic removal and new validation patterns that warrant attention.

Possibly related PRs

chore: rename default branch from master to main #10: Makes identical branch migration edits across CI/config files (.github/workflows/release.yml, .pre-commit-config.yaml, .releaserc.json) and documentation to transition from master to main branch.

Poem

🐰 Master's gone, long live main—
Branch so clean, no more refrain!
Silent CLI, quiet and keen,
Status whispers fade unseen.
Hop on, dear main, our future's bright! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title "feat: remove status messages and make --debug require --verbose" directly and clearly describes the primary functional changes in this pull request. The changeset's main content involves removing status message outputs from the CLI (affecting peakbagger/cli.py and documentation) and adding a validation requirement that --debug must be paired with --verbose. While the PR also includes supporting changes to branch configuration files and documentation across multiple files, the title appropriately focuses on the most significant user-facing behavioral changes. The title is concise, specific, and avoids vague terminology.
Description Check	✅ Passed	The PR description is mostly complete and well-structured, including a clear Summary section that explains the core changes, a comprehensive Changes section with checkmarks indicating completed tasks, a Behavior section with before/after examples showing the new CLI output patterns, and a Test plan section documenting what was validated. The only element missing from the template is the formal Type section with checkboxes (feat/fix/feat!/fix!/chore/docs/refactor/test/ci), though the type is already indicated in the PR title prefix "feat:" which satisfies the requirement. The description provides substantial detail about the changes and their impact, making it a valuable reference for reviewers and the project history.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feat/remove-status-messages

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0561350 and ac72bd9.

⛔ Files ignored due to path filters (1)

uv.lock is excluded by !**/*.lock

📒 Files selected for processing (6)

.github/workflows/release.yml (0 hunks)
.pre-commit-config.yaml (1 hunks)
.releaserc.json (1 hunks)
CLAUDE.md (5 hunks)
README.md (0 hunks)
peakbagger/cli.py (5 hunks)

💤 Files with no reviewable changes (2)

README.md
.github/workflows/release.yml

🧰 Additional context used

📓 Path-based instructions (6)

{peakbagger,tests,scripts}/**/*.py

📄 CodeRabbit inference engine (CLAUDE.md)

Use Python 3.12+ modern typing; prefer X | None instead of Optional[X]

Files:

peakbagger/cli.py

peakbagger/**/*.py

📄 CodeRabbit inference engine (CLAUDE.md)

peakbagger/**/*.py: All public functions and classes must have docstrings
Add type hints for all function parameters and return values
Use proper exception chaining (raise ... from e) for error handling
Never use print() for debugging or informational logs; use loguru logger

Files:

peakbagger/cli.py

peakbagger/{cli.py,formatters.py}

📄 CodeRabbit inference engine (CLAUDE.md)

Use Rich for all user-facing terminal output; do not use print() for UI output

Files:

peakbagger/cli.py

peakbagger/{logging_config.py,cli.py}

📄 CodeRabbit inference engine (CLAUDE.md)

Default log level is CRITICAL; users enable via --verbose (INFO) or --debug (DEBUG) flags

Files:

peakbagger/cli.py

{peakbagger/cli.py,peakbagger/client.py}

📄 CodeRabbit inference engine (CLAUDE.md)

Respect and expose rate limiting via CLI flags (e.g., --rate-limit), defaulting to 2.0 seconds

Files:

peakbagger/cli.py

CLAUDE.md

📄 CodeRabbit inference engine (CLAUDE.md)

Update CLAUDE.md when new output fields or formats are added

Files:

CLAUDE.md

🧠 Learnings (6)