Skip to content

chore: add npm metadata links - #384

Open
gshaowei6 wants to merge 1 commit into
OneBusAway:mainfrom
gshaowei6:fix/npm-metadata-links
Open

chore: add npm metadata links#384
gshaowei6 wants to merge 1 commit into
OneBusAway:mainfrom
gshaowei6:fix/npm-metadata-links

Conversation

@gshaowei6

@gshaowei6 gshaowei6 commented Jun 10, 2026

Copy link
Copy Markdown

Summary

This adds the npm package metadata links that are currently missing from package.json:

  • homepage points to the repository README
  • bugs.url points to the repository issue tracker

No runtime code, exports, dependencies, or generated files are changed.

Verification

  • node -e "const p=require('./package.json'); if (p.bugs?.url !== 'https://github.com/OneBusAway/js-sdk/issues' || p.homepage !== 'https://github.com/OneBusAway/js-sdk#readme') process.exit(1)"
  • git diff --cached --check
  • npm pack --dry-run --json --ignore-scripts
  • corepack yarn install --frozen-lockfile --ignore-scripts
  • .\node_modules\.bin\tsc.cmd --noEmit
  • .\node_modules\.bin\jest.cmd --runInBand tests/stringifyQuery.test.ts tests/responses.test.ts

I also exported the committed tree into WSL Ubuntu 26.04 with LF line endings and verified:

  • npm pkg get homepage bugs --json
  • npm pack --dry-run --json --ignore-scripts

Summary by CodeRabbit

  • Chores
    • Updated project metadata to include homepage and bug reporting information.

@coderabbitai

coderabbitai Bot commented Jun 10, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: df739fe9-fcb8-46dd-a1a8-16f6c3d00f17

📥 Commits

Reviewing files that changed from the base of the PR and between 026d132 and db5487a.

📒 Files selected for processing (1)
  • package.json

📝 Walkthrough

Walkthrough

This PR adds two metadata fields to package.json: a homepage URL and a bugs.url for reporting issues. No code entities, dependencies, or functionality are changed.

Changes

Package Metadata

Layer / File(s) Summary
Homepage and bugs metadata
package.json
homepage and bugs.url metadata fields are added to package metadata.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 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 'chore: add npm metadata links' directly and clearly summarizes the main change: adding npm package metadata fields (homepage and bugs.url) to package.json.
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

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.

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

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.

2 participants