Unify CLI output and wrapper-owned help - #4243
Closed
codeshaunted wants to merge 1 commit into
Closed
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
⏭️ Performance benchmarks were skippedPerf benchmarks (CodSpeed) are opt-in on pull requests — they no longer run on every push. They always run automatically after merge to To run them on this PR, do any of the following, then push a commit (or re-run CI):
|
Contributor
📝 WalkthroughWalkthroughThis PR adds the shared ChangesShell and CLI integration
Estimated code review effort: 4 (Complex) | ~60 minutes Sequence Diagram(s)sequenceDiagram
participant User
participant Baml as baml wrapper
participant CLI as baml-cli
participant Shell as baml_shell::Shell
User->>Baml: request root help
Baml->>CLI: request RootHelpV1 metadata
CLI-->>Baml: return serialized help metadata
Baml->>Baml: add toolchain and self-update commands
Baml->>Shell: render merged help
Shell-->>User: print root help
Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
⚔️ Resolve merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Binary size checks passed✅ 7 passed
Generated by |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
baml_language/crates/baml/src/main.rs (1)
406-435: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winConsider logging the discarded root-help fallback reason.
toolchain_root_help's failure (spawn error, non-zero exit, JSON parse error, orvalidate()failure) is discarded viaErr(_)before falling back topass_through_resolved. If a futurebaml-cliregresses its root-help metadata, this fails silently every time with no diagnostic trail. The file already has a convention for this (crate::bytecode_cache::cache_debuginrun_command.rs) — consider a similar low-noise debug log here.♻️ Example
- Err(_) => pass_through_resolved(shell, original_args, resolved), + Err(err) => { + // Low-noise breadcrumb; doesn't affect user-visible fallback behavior. + crate::debug_log(format_args!("root-help metadata rejected: {err:#}")); + pass_through_resolved(shell, original_args, resolved) + }🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@baml_language/crates/baml/src/main.rs` around lines 406 - 435, Update the Err(_) branch in root_help to capture the toolchain_root_help failure and emit a low-noise debug diagnostic using the existing crate::bytecode_cache::cache_debug convention before calling pass_through_resolved. Preserve the fallback behavior and original arguments unchanged, while including enough error context to identify why root-help metadata was unavailable.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@baml_language/crates/baml/src/main.rs`:
- Around line 406-435: Update the Err(_) branch in root_help to capture the
toolchain_root_help failure and emit a low-noise debug diagnostic using the
existing crate::bytecode_cache::cache_debug convention before calling
pass_through_resolved. Preserve the fallback behavior and original arguments
unchanged, while including enough error context to identify why root-help
metadata was unavailable.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 891c4484-bef6-4a21-b371-0006d3ba8954
⛔ Files ignored due to path filters (1)
baml_language/Cargo.lockis excluded by!**/*.lock
📒 Files selected for processing (27)
baml_language/Cargo.tomlbaml_language/crates/baml/Cargo.tomlbaml_language/crates/baml/src/main.rsbaml_language/crates/baml/tests/freshness_e2e.rsbaml_language/crates/baml/tests/no_self_update_e2e.rsbaml_language/crates/baml_cli/Cargo.tomlbaml_language/crates/baml_cli/src/auth.rsbaml_language/crates/baml_cli/src/commands.rsbaml_language/crates/baml_cli/src/describe_command.rsbaml_language/crates/baml_cli/src/feedback_command.rsbaml_language/crates/baml_cli/src/grep_command.rsbaml_language/crates/baml_cli/src/lib.rsbaml_language/crates/baml_cli/src/main.rsbaml_language/crates/baml_cli/src/output.rsbaml_language/crates/baml_cli/src/reporter.rsbaml_language/crates/baml_cli/src/run_command.rsbaml_language/crates/baml_cli/src/telemetry/storage.rsbaml_language/crates/baml_cli/src/telemetry_command.rsbaml_language/crates/baml_cli/src/test_command.rsbaml_language/crates/baml_exec/Cargo.tomlbaml_language/crates/baml_exec/src/clap_target.rsbaml_language/crates/baml_exec/src/diag_print.rsbaml_language/crates/baml_exec/src/lib.rsbaml_language/crates/baml_pack_host/src/main.rsbaml_language/crates/baml_shell/Cargo.tomlbaml_language/crates/baml_shell/src/lib.rsbaml_language/stow.toml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
baml_shell::Shellfor diagnostics, statuses, color policy, Clap styling, and root-help rendering__baml-root-help-v1metadata command tobaml-clitoolchainandself-updateTesting
baml_cliunit tests (412 passed)Tested on macOS.
Summary by CodeRabbit
New Features
Bug Fixes