Add icon and README to CLI-installed BAML extension by rossirpaulo · Pull Request #4292 · BoundaryML/baml

rossirpaulo · 2026-07-30T20:04:19Z

Summary

add the BAML logo as the extension icon and BAML file icon
package a README with CLI installation and update instructions for VS Code and Cursor
validate that release VSIX artifacts contain the README and logo while continuing to reject native binaries

Why

The CLI-installed extension did not declare an icon or include user-facing installation and update documentation. The release workflow also did not verify those files were present in the packaged VSIX.

Linear: https://linear.app/boundaryml2/issue/B-1030/add-icon-file-icons-readme-and-update-command-for-cli-installed

Validation

cargo build --manifest-path baml_language/Cargo.toml --release --bin baml-cli --bin baml-pack-host
CI=true pnpm --dir typescript2 run vscode:package
verified the assembled release CLI exports the bundled VSIX byte-for-byte with baml-cli ide install --output-dir
verified the VSIX contains extension/readme.md and extension/baml-logo.png and excludes native binaries
pre-commit hooks and git diff --check pass

Summary by CodeRabbit

New Features
- Added BAML branding icons for the VS Code and Cursor extensions, including light and dark theme support.
- Updated the extension description to highlight BAML as a programming language for AI.
- Documented extension capabilities, installation instructions, update guidance, and further resources.
Bug Fixes
- Improved release validation for required extension assets and bundled content.
- Improved package version updates for more reliable releases and formatting preservation.

vercel · 2026-07-30T20:04:26Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
beps	Ready	Preview	Jul 31, 2026 8:18pm
promptfiddle2	Ready	Preview	Jul 31, 2026 8:18pm

github-actions · 2026-07-30T20:05:16Z

⏭️ Performance benchmarks were skipped

Perf benchmarks (CodSpeed) are opt-in on pull requests — they no longer run on every push. They always run automatically after merge to canary/main.

To run them on this PR, do any of the following, then push a commit (or re-run CI):

Add RUN_CODSPEED=1 to the PR description, or
Include run-perf or /perf in the PR title or any commit message.

coderabbitai · 2026-07-30T20:06:24Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: b4723b02-8a16-4b87-a364-80983e0a1c0e

📥 Commits

Reviewing files that changed from the base of the PR and between 46e23f3 and 343cecc.

📒 Files selected for processing (1)

scripts/tests/test_baml_language_version.py

🚧 Files skipped from review as they are similar to previous changes (1)

scripts/tests/test_baml_language_version.py

📝 Walkthrough

Walkthrough

The VS Code extension now includes BAML branding and installation documentation. Release tooling updates JSON package versions and validates that VSIX files contain the README and logo while continuing to reject native binaries.

Changes

VS Code extension assets

Layer / File(s)	Summary
Extension branding and documentation `typescript2/app-vscode-ext/package.json`, `typescript2/app-vscode-ext/README.md`	The manifest adds extension and language icons and updates the description. The README documents capabilities, installation, updates, and documentation links.

Release packaging

Layer / File(s)	Summary
JSON version stamping `scripts/baml-language-version`, `scripts/tests/test_baml_language_version.py`	Version stamping now updates a single top-level JSON `version` property and preserves comma formatting. Tests cover field order and trailing-field formatting.
Packaged asset validation `.github/workflows/release-baml-language.yml`	VSIX validation uses a filename-only listing, requires the README and logo, and retains native-binary rejection.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

BoundaryML/baml#3986: Relates to VS Code extension packaging and manifest artifacts.

Poem

A rabbit checks the logo bright,
And packs the README snug and tight.
JSON versions fall in line,
VSIX files pass the sign.
Native binaries stay out of sight.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly identifies the main user-facing changes: adding an icon and README to the CLI-installed BAML extension.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch agent/add-baml-extension-icon-readme

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.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

github-actions · 2026-07-30T20:18:00Z

Binary size checks passed

✅ 7 passed

	Artifact	Platform	File	Gzip	Gated on	Baseline	Delta	Status
✅	`baml-cli`	Linux	🔒 27.4 MB	11.6 MB	file	27.4 MB	-12.2 KB (-0.0%)	OK
✅	`packed-program`	Linux	🔒 17.7 MB	7.3 MB	file	17.7 MB	+23.1 KB (+0.1%)	OK
✅	`baml-cli`	macOS	🔒 21.3 MB	10.2 MB	file	21.3 MB	-35.0 KB (-0.2%)	OK
✅	`packed-program`	macOS	🔒 13.8 MB	6.4 MB	file	13.8 MB	-4.6 KB (-0.0%)	OK
✅	`baml-cli`	Windows	🔒 22.9 MB	10.4 MB	file	23.0 MB	-54.9 KB (-0.2%)	OK
✅	`packed-program`	Windows	🔒 14.8 MB	6.5 MB	file	14.8 MB	-14.3 KB (-0.1%)	OK
✅	`bridge_wasm`	WASM	16.8 MB	🔒 4.6 MB	gzip	4.6 MB	-41.8 KB (-0.9%)	OK

🔒 = the size this artifact is GATED on (ceiling + delta). Binaries gate on file size (installed binary); WASM gates on gzip (download size). The other size is shown for information only.

Generated by cargo size-gate · workflow run

coderabbitai

🧹 Nitpick comments (1)

scripts/tests/test_baml_language_version.py (1)
99-99: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Cover the comma-preserving branch.

This fixture places "version" last. It tests key ordering and the no-comma case, but it does not verify that a comma remains when another property follows. Add a field after "version" or test replace_json_version directly.
🤖 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 `@scripts/tests/test_baml_language_version.py` at line 99, Add coverage for the
comma-preserving branch in the fixture around replace_json_version by placing
another JSON property after "version", or by directly testing
replace_json_version with a following property, while retaining the existing
ordering and no-comma coverage.

🤖 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 `@scripts/tests/test_baml_language_version.py`:
- Line 99: Add coverage for the comma-preserving branch in the fixture around
replace_json_version by placing another JSON property after "version", or by
directly testing replace_json_version with a following property, while retaining
the existing ordering and no-comma coverage.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 6bf2f732-899b-4518-9960-eff428e10627

📥 Commits

Reviewing files that changed from the base of the PR and between 54ff4f6 and 46e23f3.

⛔ Files ignored due to path filters (1)

typescript2/app-vscode-ext/baml-logo.png is excluded by !**/*.png

📒 Files selected for processing (5)

.github/workflows/release-baml-language.yml
scripts/baml-language-version
scripts/tests/test_baml_language_version.py
typescript2/app-vscode-ext/README.md
typescript2/app-vscode-ext/package.json

🚧 Files skipped from review as they are similar to previous changes (2)

typescript2/app-vscode-ext/README.md
typescript2/app-vscode-ext/package.json

vercel Bot deployed to Preview – beps July 30, 2026 20:05 View deployment

coderabbitai Bot approved these changes Jul 30, 2026

View reviewed changes

vercel Bot deployed to Preview – promptfiddle2 July 30, 2026 20:12 View deployment

rossirpaulo added 2 commits July 31, 2026 12:43

Add icon and README to BAML extension

32c52a2

Update BAML extension copy

cf4f08d

rossirpaulo force-pushed the agent/add-baml-extension-icon-readme branch from 665e4a6 to cf4f08d Compare July 31, 2026 19:43

vercel Bot deployed to Preview – beps July 31, 2026 19:45 View deployment

Format VS Code extension manifest

e5842c2

vercel Bot deployed to Preview – beps July 31, 2026 19:49 View deployment

This comment has been minimized.

Sign in to view

Make JSON version stamping order-independent

46e23f3

vercel Bot deployed to Preview – beps July 31, 2026 19:54 View deployment

vercel Bot deployed to Preview – promptfiddle2 July 31, 2026 20:01 View deployment

coderabbitai Bot reviewed Jul 31, 2026

View reviewed changes

Test JSON version comma preservation

343cecc

vercel Bot deployed to Preview – beps July 31, 2026 20:10 View deployment

vercel Bot deployed to Preview – promptfiddle2 July 31, 2026 20:18 View deployment

rossirpaulo added this pull request to the merge queue Jul 31, 2026

Merged via the queue into canary with commit a85e8ed Jul 31, 2026
83 checks passed

rossirpaulo deleted the agent/add-baml-extension-icon-readme branch July 31, 2026 20:36

coderabbitai Bot mentioned this pull request Aug 6, 2026

Transparent file icon for vscode #4336

Merged

Navigation Menu

Uh oh!

Add icon and README to CLI-installed BAML extension - #4292

Add icon and README to CLI-installed BAML extension#4292
rossirpaulo merged 5 commits into
canaryfrom
agent/add-baml-extension-icon-readme

rossirpaulo commented Jul 30, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

vercel Bot commented Jul 30, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jul 30, 2026

Uh oh!

coderabbitai Bot commented Jul 30, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

github-actions Bot commented Jul 30, 2026 •

edited

Loading

Uh oh!

This comment has been minimized.

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

rossirpaulo commented Jul 30, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Why

Validation

Summary by CodeRabbit

Uh oh!

vercel Bot commented Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 30, 2026

⏭️ Performance benchmarks were skipped

Uh oh!

coderabbitai Bot commented Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

github-actions Bot commented Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Binary size checks passed

Uh oh!

This comment has been minimized.

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

rossirpaulo commented Jul 30, 2026 •

edited by coderabbitai Bot

Loading

vercel Bot commented Jul 30, 2026 •

edited

Loading

coderabbitai Bot commented Jul 30, 2026 •

edited

Loading

github-actions Bot commented Jul 30, 2026 •

edited

Loading