Skip to content

feat(auto-readme): add packageLinks preset badges (jsr, bundlesize)#289

Open
stephansama wants to merge 1 commit into
mainfrom
stephansama/ste-38-add-more-badges-to-readmes-and-readme-template
Open

feat(auto-readme): add packageLinks preset badges (jsr, bundlesize)#289
stephansama wants to merge 1 commit into
mainfrom
stephansama/ste-38-add-more-badges-to-readmes-and-readme-template

Conversation

@stephansama

Copy link
Copy Markdown
Owner

Closes STE-38

Adds a new badgeOptions.packageLinks config field that lets consumers opt into built-in badge presets by short name instead of hand-rolling the full {url, image, label} shape. Three presets shipped in this PR:

  • jsr — JSR registry badge
  • bundlesize — bundlephobia minified size
  • bundlesizeGzip — bundlephobia minified+gzip size

Usage:

{
  "badgeOptions": {
    "packageLinks": ["jsr", "bundlesize", "bundlesizeGzip"]
  }
}

Presets expand into the same internal shape as user templates and pass through the existing Handlebars context, so --skip-templates skips them too. Presets are rendered before user templates in the BADGE row.

Acceptance criteria

  • jsr preset emits the jsr.io badge linking to jsr.io/{name}
  • bundlesize preset emits the bundlephobia min badge
  • bundlesizeGzip preset emits the bundlephobia min+gzip badge
  • github preset (needs owner/repo extraction from pkg.repository.url — deferred to a follow-up so this PR stays scoped)

Notes

  • README files across the monorepo will pick up the new badges automatically on next auto-readme run (config update in .config/autoreadmerc.json to add packageLinks is separate).

@vercel

vercel Bot commented May 18, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
packages Ready Ready Preview, Comment May 18, 2026 2:37am

@changeset-bot

changeset-bot Bot commented May 18, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 720b8a0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented May 18, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@stephansama has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 48 minutes and 1 second before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: c650bbc3-305a-44f2-8225-3323ed149e77

📥 Commits

Reviewing files that changed from the base of the PR and between 9a84b42 and 720b8a0.

📒 Files selected for processing (2)
  • core/auto-readme/src/plugin.ts
  • core/auto-readme/src/schema.ts
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch stephansama/ste-38-add-more-badges-to-readmes-and-readme-template

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 and usage tips.

@codecov

codecov Bot commented May 18, 2026

Copy link
Copy Markdown

⚠️ JUnit XML file not found

The CLI was unable to find any JUnit XML files to upload.
For more help, visit our troubleshooting guide.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces built-in badge presets for the auto-readme plugin. It adds a packageLinkPresets object in schema.ts containing configurations for bundlesize, bundlesizeGzip, and jsr badges, and updates the configuration schema to support a new packageLinks option. The plugin logic in plugin.ts is updated to merge these selected presets with user-defined templates when generating badges. I have no feedback to provide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant