Skip to content

Add zod-annotator npm metadata#474

Open
shensz2017 wants to merge 1 commit into
ts-safeql:mainfrom
shensz2017:fix-zod-annotator-package-metadata
Open

Add zod-annotator npm metadata#474
shensz2017 wants to merge 1 commit into
ts-safeql:mainfrom
shensz2017:fix-zod-annotator-package-metadata

Conversation

@shensz2017

@shensz2017 shensz2017 commented Jun 8, 2026

Copy link
Copy Markdown

Summary

  • Add package-level homepage metadata for @ts-safeql/zod-annotator.
  • Add package-level bugs metadata pointing npm users to the repository issues page.
  • Add a patch changeset for the package metadata update.

Why

The published npm package currently exposes repository metadata but no homepage or bugs fields, so users browsing npm do not get direct links to the package source folder or issue tracker.

Validation

  • node -e "const p=require('./packages/zod-annotator/package.json'); if(p.homepage!=='https://github.com/ts-safeql/safeql/tree/main/packages/zod-annotator') throw new Error('homepage mismatch'); if(p.bugs?.url!=='https://github.com/ts-safeql/safeql/issues') throw new Error('bugs mismatch'); console.log('metadata smoke ok')"
  • npm pack --dry-run --ignore-scripts ./packages/zod-annotator
  • git diff --check

Summary by CodeRabbit

Chores

  • Updated package metadata including homepage and bug tracker information for improved discoverability
  • Tagged @ts-safeql/zod-annotator as a patch release

@changeset-bot

changeset-bot Bot commented Jun 8, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: cdc8da9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@ts-safeql/zod-annotator Patch

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

@vercel

vercel Bot commented Jun 8, 2026

Copy link
Copy Markdown

@shensz2017 is attempting to deploy a commit to the newbie012's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jun 8, 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

Run ID: 3540f1ed-5386-494b-b774-faf63a122858

📥 Commits

Reviewing files that changed from the base of the PR and between 8adab0c and cdc8da9.

📒 Files selected for processing (2)
  • .changeset/green-spoons-wave.md
  • packages/zod-annotator/package.json

📝 Walkthrough

Walkthrough

This PR updates the zod-annotator package with additional metadata fields and corresponding release documentation. The package.json was updated to include homepage and bugs.url metadata entries, and a changeset file was created to mark this update as a patch release for @ts-safeql/zod-annotator, including the npm package metadata in the release notes.

Poem

🐰 A spoonful of metadata, freshly mined,
Homepage and bugs tracked, neatly aligned,
The changeset blooms in waves of green,
A patch release, small but keen!

🚥 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 'Add zod-annotator npm metadata' accurately summarizes the main change: adding npm package metadata (homepage and bugs.url fields) to the @ts-safeql/zod-annotator package.
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.

@greptile-apps

greptile-apps Bot commented Jun 8, 2026

Copy link
Copy Markdown

Greptile Summary

This PR adds homepage and bugs metadata fields to the @ts-safeql/zod-annotator package.json, and includes a corresponding patch changeset. The URLs are correct — homepage points to the package subdirectory on the main branch and bugs.url points to the repo's GitHub issues page.

  • packages/zod-annotator/package.json: Adds homepage and bugs fields in the correct position (after repository, before files), with accurate URLs.
  • .changeset/green-spoons-wave.md: Patch changeset correctly scoped to @ts-safeql/zod-annotator with a clear description.

Confidence Score: 5/5

This is a pure metadata-only change with no runtime code modifications — safe to merge.

Both added fields (homepage and bugs) are standard npm metadata that have no effect on package behaviour, build output, or type definitions. The URLs correctly reference the package subdirectory and the repo issues tracker. The changeset is properly scoped as a patch.

No files require special attention.

Important Files Changed

Filename Overview
packages/zod-annotator/package.json Adds homepage and bugs metadata fields with correct URLs pointing to the package subdirectory and the repo issues page.
.changeset/green-spoons-wave.md New patch changeset for @ts-safeql/zod-annotator, correctly scoped and formatted.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[package.json] --> B[homepage field added]
    A --> C[bugs field added]
    B --> D[Links to package subdirectory on GitHub]
    C --> E[Links to repo issues page on GitHub]
    F[changeset file] --> G[Patch bump for zod-annotator]
Loading

Reviews (1): Last reviewed commit: "Add zod-annotator npm metadata" | Re-trigger Greptile

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