Skip to content

chore: add package support metadata#65

Merged
chenjiahan merged 1 commit into
rstackjs:mainfrom
YfengJ:codex/package-support-metadata
Jun 18, 2026
Merged

chore: add package support metadata#65
chenjiahan merged 1 commit into
rstackjs:mainfrom
YfengJ:codex/package-support-metadata

Conversation

@YfengJ

@YfengJ YfengJ commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add the package homepage pointing to the repository README
  • add the package bugs URL pointing to the repository issues page

Why

The published npm metadata currently exposes the repository and license, but does not include homepage or bugs fields. Adding these fields makes the package support links easier to discover from npm and package tooling.

Current npm metadata checked with:

npm view rsbuild-plugin-open-graph@latest name version repository homepage bugs license --json
{
  "name": "rsbuild-plugin-open-graph",
  "version": "1.1.3",
  "repository": "https://github.com/rstackjs/rsbuild-plugin-open-graph",
  "license": "MIT"
}

Validation

  • node -e "const p=require('./package.json'); if(p.homepage !== 'https://github.com/rstackjs/rsbuild-plugin-open-graph#readme') throw new Error('bad homepage'); if(!p.bugs || p.bugs.url !== 'https://github.com/rstackjs/rsbuild-plugin-open-graph/issues') throw new Error('bad bugs url'); console.log(JSON.stringify({homepage:p.homepage, bugs:p.bugs}, null, 2));"
  • pnpm install --frozen-lockfile --ignore-scripts
  • pnpm run lint
  • pnpm run build
  • pnpm run test
  • npm pack --dry-run --ignore-scripts --json .
  • git diff --check

Note: pnpm run prettier currently reports formatting warnings for src/index.ts and src/toSnakeCase.ts. I reproduced the same result on untouched upstream/main, so I left those unrelated source files unchanged in this metadata-only PR.

@coderabbitai

coderabbitai Bot commented Jun 18, 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: 2fe67b6a-661a-419d-aa7c-4d076e67d4f1

📥 Commits

Reviewing files that changed from the base of the PR and between 117e204 and 03b73cc.

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

📝 Walkthrough

Walkthrough

The package.json file was updated with two new metadata fields: a homepage URL pointing to the project's GitHub repository and a bugs object containing a url field pointing to the GitHub issues page. No other fields were modified and no source code was changed.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'chore: add package support metadata' accurately and concisely describes the main change of adding package.json metadata fields.
Description check ✅ Passed The description provides clear context about the changes, explaining what was added (homepage and bugs fields), why (discoverability), and includes validation steps taken.
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

Comment @coderabbitai help to get the list of available commands and usage tips.

@chenjiahan chenjiahan merged commit f031da1 into rstackjs:main Jun 18, 2026
3 checks passed
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