docs(core): update npm links to npmx.dev#222
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🦋 Changeset detectedLatest commit: 01a9fcf The changes in this PR will be included in the next version bump. This PR includes changesets to release 21 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Summary of ChangesHello @stephansama, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request systematically updates all references to Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
📝 WalkthroughSummary by CodeRabbit
WalkthroughThis pull request replaces npmjs.com/npmjs.org links with npmx.dev links across many README badges and one example anchor, and updates the README template and a changeset to reflect the registry change. No code or public API/signature changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 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 |
There was a problem hiding this comment.
Code Review
This pull request updates the NPM links from npmjs.com to npmx.dev across various documentation files. The changes are mostly correct and align with the PR's goal. I've found one minor issue in a README file where a badge points to an incorrect package, and I've provided a suggestion to fix it. Otherwise, great work on this widespread update!
More templates
@stephansama/ai-commit-msg
@stephansama/alfred-kaomoji
@stephansama/astro-iconify-svgmap
@stephansama/auto-readme
@stephansama/catppuccin-opml
@stephansama/catppuccin-rss
@stephansama/catppuccin-typedoc
@stephansama/catppuccin-xsl
create-stephansama-example
@stephansama/find-makefile-targets
@stephansama/github-env
@stephansama/multipublish
@stephansama/prettier-plugin-handlebars
@stephansama/remark-asciinema
@stephansama/svelte-social-share-links
@stephansama/typed-env
@stephansama/typed-events
@stephansama/typed-nocodb-api
@stephansama/typed-templates
@stephansama/types-lhci
commit: |
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
core/auto-readme/README.md (1)
197-197:⚠️ Potential issue | 🟡 MinorUpdate stale
registryUrldefault in schema.ts to match registry migration.The
registryUrldefault incore/auto-readme/src/schema.ts(line 56) is still set to"https://www.npmjs.com/package/{{name}}", while the template and README badges have been updated tonpmx.dev. This causes the auto-generated schema documentation in README.md (line 197) to reflect the stale value. Update the schema default to"https://www.npmx.dev/package/{{name}}"to maintain consistency across the codebase.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@core/auto-readme/README.md` at line 197, The README shows a stale default for the templates.registryUrl; update the default value in core/auto-readme/src/schema.ts (the schema that defines the `templates` object / `registryUrl` default) from "https://www.npmjs.com/package/{{name}}" to "https://www.npmx.dev/package/{{name}}". Locate the `registryUrl` entry in the schema (where the `templates` defaults are defined) and replace the old URL string with the new `npmx.dev` URL so the generated docs and README match the migrated registry.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@core/catppuccin-rss/README.md`:
- Around line 5-6: The NPM Version badge currently points to
`@stephansama/remark-asciinema` instead of `@stephansama/catppuccin-rss`; update the
markdown badge href and image query to use the correct package name
(`@stephansama/catppuccin-rss`) so the version shield and link reference the
catppuccin-rss package rather than remark-asciinema.
In `@README.md`:
- Line 13: Change the phrase "Collection of open source
[npm](https://www.npmx.dev/) packages" in README.md to use the hyphenated
adjective form "open‑source", i.e., "Collection of open‑source npm packages."
Ensure the link markup and spacing remain correct around the npm text.
---
Outside diff comments:
In `@core/auto-readme/README.md`:
- Line 197: The README shows a stale default for the templates.registryUrl;
update the default value in core/auto-readme/src/schema.ts (the schema that
defines the `templates` object / `registryUrl` default) from
"https://www.npmjs.com/package/{{name}}" to
"https://www.npmx.dev/package/{{name}}". Locate the `registryUrl` entry in the
schema (where the `templates` defaults are defined) and replace the old URL
string with the new `npmx.dev` URL so the generated docs and README match the
migrated registry.
ℹ️ Review info
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (23)
README.mdcore/ai-commit-msg/README.mdcore/alfred-kaomoji/README.mdcore/astro-iconify-svgmap/README.mdcore/auto-readme/README.mdcore/catppuccin-opml/README.mdcore/catppuccin-rss/README.mdcore/catppuccin-typedoc/README.mdcore/catppuccin-xsl/README.mdcore/example/README.mdcore/find-makefile-targets/README.mdcore/github-env/README.mdcore/multipublish/README.mdcore/prettier-plugin-handlebars/README.mdcore/remark-asciinema/README.mdcore/svelte-social-share-links/README.mdcore/typed-env/README.mdcore/typed-events/README.mdcore/typed-nocodb-api/README.mdcore/typed-templates/README.mdcore/types-lhci/README.mdexamples/typed-events/react/app/routes/home.tsxturbo/generators/templates/lib/README.md.hbs
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
♻️ Duplicate comments (2)
core/catppuccin-rss/README.md (1)
5-6: LGTM — both badges correctly reference@stephansama/catppuccin-rssand point to valid npmx.dev URLs.The previously reported wrong-package bug (remark-asciinema reference) is confirmed fixed. npmx.dev is URL-compatible with npmjs.com — replacing
npmjs.comwithnpmx.devin any URL works as expected.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@core/catppuccin-rss/README.md` around lines 5 - 6, No code changes required: the two badge links in README.md already correctly reference the package name `@stephansama/catppuccin-rss` and point to npmx.dev; leave the existing badge lines (the two Markdown image/link lines) as-is and do not revert to the old npmjs.com URLs or the old package name.README.md (1)
13-13: LGTM — grammar fix and registry link update are both correct.The hyphenation of "open-source" addresses the previous grammar note, and
https://www.npmx.dev/is a valid destination. npmx.dev is a fast, modern browser for the npm registry — it doesn't aim to replace npmjs.com but provides a better UI and developer experience for browsing packages.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 13, Keep the approved grammar and link change in the README by ensuring the phrase reads "Collection of open-source [npm](https://www.npmx.dev/) packages" (preserve the hyphenated "open-source" and the updated npmx.dev registry URL) so the README reflects the corrected wording and registry link.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@core/catppuccin-rss/README.md`:
- Around line 5-6: No code changes required: the two badge links in README.md
already correctly reference the package name `@stephansama/catppuccin-rss` and
point to npmx.dev; leave the existing badge lines (the two Markdown image/link
lines) as-is and do not revert to the old npmjs.com URLs or the old package
name.
In `@README.md`:
- Line 13: Keep the approved grammar and link change in the README by ensuring
the phrase reads "Collection of open-source [npm](https://www.npmx.dev/)
packages" (preserve the hyphenated "open-source" and the updated npmx.dev
registry URL) so the README reflects the corrected wording and registry link.
ℹ️ Review info
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (3)
.changeset/poor-seals-beam.mdREADME.mdcore/catppuccin-rss/README.md
Checklist
mainhave been mergedmain