feat(config): add npmgraph badge to autoreadmerc.json#286
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
Warning Review limit reached
More reviews will be available in 58 minutes and 46 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the 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 include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR adds a new npmgraph badge template to the README generation configuration. The badge generates a link to npmgraph.js.org with the package name and displays a corresponding Shields badge image. npmgraph Badge Configuration
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
@stephansama/ai-commit-msg
@stephansama/alfred-kaomoji
@stephansama/astro-iconify-svgmap
@stephansama/auto-readme
@stephansama/catppuccin-jsonresume-theme
@stephansama/catppuccin-opml
@stephansama/catppuccin-rss
@stephansama/catppuccin-typedoc
@stephansama/catppuccin-xsl
@stephansama/eslint-config
create-stephansama-example
@stephansama/find-makefile-targets
@stephansama/github-env
@stephansama/multipublish
@stephansama/pnpm-hooks
@stephansama/prettier-plugin-handlebars
@stephansama/remark-asciinema
@stephansama/single-file
@stephansama/svelte-social-share-links
@stephansama/typed-env
@stephansama/typed-events
@stephansama/typed-nocodb-api
@stephansama/typed-templates
@stephansama/types-github-action-env
@stephansama/types-lhci
commit: |
There was a problem hiding this comment.
Code Review
This pull request adds a new badge configuration for npmgraph to the .config/autoreadmerc.json file, including a link to the dependency graph and a corresponding shield image. The reviewer suggested updating the badge logo from GraphQL to npm to more accurately represent the tool and avoid misleading users.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Closes STE-164
Adds a per-package "npmgraph" badge to the BADGE row generated by
auto-readme. ThebadgeOptions.templatesarray in.config/autoreadmerc.jsonalready supports arbitrary entries — no source change tocore/auto-readme. Uses{{escaped_name}}(i.e.encodeURIComponent(name)) so scoped packages like@stephansama/fooURL-encode correctly when linking to npmgraph.js.org.Acceptance criteria
badgeOptions.templatesin.config/autoreadmerc.json.core/auto-readme/source — the package handles the new entry out of the box.auto-readmeagainst any package emits a new "npmgraph" badge in the BADGE zone (verify on next release).