Skip to content

feat(config): add npmgraph badge to autoreadmerc.json#286

Open
stephansama wants to merge 2 commits into
mainfrom
stephansama/ste-164-add-npmgraph-to-packages
Open

feat(config): add npmgraph badge to autoreadmerc.json#286
stephansama wants to merge 2 commits into
mainfrom
stephansama/ste-164-add-npmgraph-to-packages

Conversation

@stephansama

Copy link
Copy Markdown
Owner

Closes STE-164

Adds a per-package "npmgraph" badge to the BADGE row generated by auto-readme. The badgeOptions.templates array in .config/autoreadmerc.json already supports arbitrary entries — no source change to core/auto-readme. Uses {{escaped_name}} (i.e. encodeURIComponent(name)) so scoped packages like @stephansama/foo URL-encode correctly when linking to npmgraph.js.org.

Acceptance criteria

  • One new entry added to badgeOptions.templates in .config/autoreadmerc.json.
  • Zero edits to core/auto-readme/ source — the package handles the new entry out of the box.
  • Re-running auto-readme against any package emits a new "npmgraph" badge in the BADGE zone (verify on next release).

@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:25am

@changeset-bot

changeset-bot Bot commented May 18, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 26c7996

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

Review Change Stack

Warning

Review limit reached

@stephansama, we couldn't start this review because you've reached your PR review rate limit.

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 @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 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 configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 614e32dd-4dc3-4d77-b6be-8481be1143e7

📥 Commits

Reviewing files that changed from the base of the PR and between 165afd8 and 26c7996.

📒 Files selected for processing (1)
  • .config/autoreadmerc.json
📝 Walkthrough

Walkthrough

This 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

Layer / File(s) Summary
npmgraph badge template
.config/autoreadmerc.json
New badge template object inserted into badgeOptions.templates to emit npmgraph badges with dependency visualization links and Shields badge images.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

A rabbit adds a shiny badge so fine,
npmgraph links dance in a line,
Shields gleam bright with flair,
Dependencies visible in the air! 🐰✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description provides context, acceptance criteria, and implementation details, but does not follow the required checklist template with sections for merging, conflicts, linting, and testing. Add the required checklist items from the template: Latest changes merged, conflicts resolved, branch pointing to main, Eslint status, and unit test results.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding an npmgraph badge entry to the autoreadmerc.json configuration file.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch stephansama/ste-164-add-npmgraph-to-packages

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

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@pkg-pr-new

pkg-pr-new Bot commented May 18, 2026

Copy link
Copy Markdown

Open in StackBlitz

@stephansama/ai-commit-msg

pnpm add https://pkg.pr.new/@stephansama/ai-commit-msg@286

@stephansama/alfred-kaomoji

pnpm add https://pkg.pr.new/@stephansama/alfred-kaomoji@286

@stephansama/astro-iconify-svgmap

pnpm add https://pkg.pr.new/@stephansama/astro-iconify-svgmap@286

@stephansama/auto-readme

pnpm add https://pkg.pr.new/@stephansama/auto-readme@286

@stephansama/catppuccin-jsonresume-theme

pnpm add https://pkg.pr.new/@stephansama/catppuccin-jsonresume-theme@286

@stephansama/catppuccin-opml

pnpm add https://pkg.pr.new/@stephansama/catppuccin-opml@286

@stephansama/catppuccin-rss

pnpm add https://pkg.pr.new/@stephansama/catppuccin-rss@286

@stephansama/catppuccin-typedoc

pnpm add https://pkg.pr.new/@stephansama/catppuccin-typedoc@286

@stephansama/catppuccin-xsl

pnpm add https://pkg.pr.new/@stephansama/catppuccin-xsl@286

@stephansama/eslint-config

pnpm add https://pkg.pr.new/@stephansama/eslint-config@286

create-stephansama-example

pnpm add https://pkg.pr.new/create-stephansama-example@286

@stephansama/find-makefile-targets

pnpm add https://pkg.pr.new/@stephansama/find-makefile-targets@286

@stephansama/github-env

pnpm add https://pkg.pr.new/@stephansama/github-env@286

@stephansama/multipublish

pnpm add https://pkg.pr.new/@stephansama/multipublish@286

@stephansama/pnpm-hooks

pnpm add https://pkg.pr.new/@stephansama/pnpm-hooks@286

@stephansama/prettier-plugin-handlebars

pnpm add https://pkg.pr.new/@stephansama/prettier-plugin-handlebars@286

@stephansama/remark-asciinema

pnpm add https://pkg.pr.new/@stephansama/remark-asciinema@286

@stephansama/single-file

pnpm add https://pkg.pr.new/@stephansama/single-file@286

@stephansama/svelte-social-share-links

pnpm add https://pkg.pr.new/@stephansama/svelte-social-share-links@286

@stephansama/typed-env

pnpm add https://pkg.pr.new/@stephansama/typed-env@286

@stephansama/typed-events

pnpm add https://pkg.pr.new/@stephansama/typed-events@286

@stephansama/typed-nocodb-api

pnpm add https://pkg.pr.new/@stephansama/typed-nocodb-api@286

@stephansama/typed-templates

pnpm add https://pkg.pr.new/@stephansama/typed-templates@286

@stephansama/types-github-action-env

pnpm add https://pkg.pr.new/@stephansama/types-github-action-env@286

@stephansama/types-lhci

pnpm add https://pkg.pr.new/@stephansama/types-lhci@286

commit: 165afd8

@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 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.

Comment thread .config/autoreadmerc.json Outdated
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
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