Skip to content

chore: add package support metadata#56

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

chore: add package support metadata#56
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 other package tooling.

Current npm metadata checked with:

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

Validation

  • node -e "const p=require('./package.json'); if(p.homepage !== 'https://github.com/rstackjs/rsbuild-plugin-ejs#readme') throw new Error('bad homepage'); if(!p.bugs || p.bugs.url !== 'https://github.com/rstackjs/rsbuild-plugin-ejs/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

@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: 0ca58add-4bd5-4ec6-b0c5-236465cd9752

📥 Commits

Reviewing files that changed from the base of the PR and between 79aa12e and 0736817.

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

📝 Walkthrough

Walkthrough

package.json is updated to include two new metadata fields: homepage, pointing to the repository's main page, and bugs.url, pointing to the repository's issues page. No scripts, dependencies, or other configuration entries are modified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding package support metadata (homepage and bugs fields) to package.json.
Description check ✅ Passed The description is directly related to the changeset, providing clear context about why the metadata fields are being added and comprehensive validation details.
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 23d7934 into rstackjs:main Jun 18, 2026
2 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