Skip to content

fix: add missing metadata fields to package.json#10934

Open
BWM0223 wants to merge 1 commit into
TanStack:mainfrom
BWM0223:fix/meta-1193
Open

fix: add missing metadata fields to package.json#10934
BWM0223 wants to merge 1 commit into
TanStack:mainfrom
BWM0223:fix/meta-1193

Conversation

@BWM0223

@BWM0223 BWM0223 commented Jun 13, 2026

Copy link
Copy Markdown

Adds missing bugs metadata to packages/query-core/package.json.

Fixes npm tooling unable to resolve package metadata.

Summary by CodeRabbit

  • Chores
    • Updated package metadata with bug reporting configuration.

@coderabbitai

coderabbitai Bot commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The @tanstack/query-core package.json manifest now includes a "bugs" field that points to the GitHub issues URL, enabling tools and users to reference the issue tracker directly from package metadata.

Changes

Package metadata: bugs field

Layer / File(s) Summary
Add bugs contact field
packages/query-core/package.json
A "bugs" object with the GitHub issues URL is added to the package manifest.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A tiny field for bugs so small,
Now linked to issues, one and all!
The package metadata stands tall,
With GitHub's path to heed the call. 🐛

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is minimal but does not follow the required template structure with the 🎯 Changes, ✅ Checklist, and 🚀 Release Impact sections. Update the description to include all required template sections: Changes section, Checklist with contributing guide and test confirmation, and Release Impact section.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The PR title accurately describes the main change: adding missing metadata fields (specifically the 'bugs' field) to package.json in the query-core 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (2)
packages/query-core/package.json (2)

3-19: 💤 Low value

Optional: Consider grouping metadata fields for improved readability.

The bugs, repository, homepage, and funding fields are related package metadata but scattered across the manifest (currently: version → bugs → description → repository → homepage → funding). Grouping these metadata fields together would improve readability and follow common package.json conventions.

This is a minor organizational improvement; the current placement is not incorrect.

Suggested field reorganization
  "name": "`@tanstack/query-core`",
  "version": "5.101.0",
+ "description": "The framework agnostic core that powers TanStack Query",
  "bugs": {
    "url": "https://github.com/TanStack/query/issues"
  },
+ "repository": {
+   "type": "git",
+   "url": "git+https://github.com/TanStack/query.git",
+   "directory": "packages/query-core"
+ },
+ "homepage": "https://tanstack.com/query",
+ "funding": {
+   "type": "github",
+   "url": "https://github.com/sponsors/tannerlinsley"
+ },
- "description": "The framework agnostic core that powers TanStack Query",
  "author": "tannerlinsley",
  "license": "MIT",
- "repository": {
-   "type": "git",
-   "url": "git+https://github.com/TanStack/query.git",
-   "directory": "packages/query-core"
- },
- "homepage": "https://tanstack.com/query",
- "funding": {
-   "type": "github",
-   "url": "https://github.com/sponsors/tannerlinsley"
- },
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@packages/query-core/package.json` around lines 3 - 19, Reorder the
package.json metadata to group related fields for readability: move the "bugs",
"repository", "homepage", and "funding" entries so they appear together (e.g.,
after "description" or after "license"/"author"), keeping "version",
"description", "author", and "license" intact; ensure JSON remains valid and
keys like "bugs", "repository", "homepage", and "funding" are preserved exactly
as in the current diff.

4-6: Consider aligning bugs metadata across the monorepo packages

In packages/*/package.json, only packages/query-core/package.json contains a top-level "bugs" field; all other packages listed (e.g., react-query, vue-query, solid-query, devtools, persisters, etc.) currently omit it. If consistent package metadata is intended, add the same "bugs": { "url": "https://github.com/TanStack/query/issues" } block to the other packages.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@packages/query-core/package.json` around lines 4 - 6, Add a top-level "bugs"
metadata block to all package.json files in the monorepo that currently lack it,
matching the existing entry ("bugs": { "url":
"https://github.com/TanStack/query/issues" }) found in
packages/query-core/package.json; update each package.json by inserting this
exact "bugs" object (preserving JSON formatting and trailing commas rules) so
package metadata is consistent across react-query, vue-query, solid-query,
devtools, persisters, and any other packages.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@packages/query-core/package.json`:
- Around line 3-19: Reorder the package.json metadata to group related fields
for readability: move the "bugs", "repository", "homepage", and "funding"
entries so they appear together (e.g., after "description" or after
"license"/"author"), keeping "version", "description", "author", and "license"
intact; ensure JSON remains valid and keys like "bugs", "repository",
"homepage", and "funding" are preserved exactly as in the current diff.
- Around line 4-6: Add a top-level "bugs" metadata block to all package.json
files in the monorepo that currently lack it, matching the existing entry
("bugs": { "url": "https://github.com/TanStack/query/issues" }) found in
packages/query-core/package.json; update each package.json by inserting this
exact "bugs" object (preserving JSON formatting and trailing commas rules) so
package metadata is consistent across react-query, vue-query, solid-query,
devtools, persisters, and any other packages.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 43087e6d-c0e0-4359-b340-d6cbaa88405a

📥 Commits

Reviewing files that changed from the base of the PR and between feb1efd and 226e0fb.

📒 Files selected for processing (1)
  • packages/query-core/package.json

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