fix: add missing metadata fields to package.json#10934
Conversation
📝 WalkthroughWalkthroughThe ChangesPackage metadata: bugs field
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (2)
packages/query-core/package.json (2)
3-19: 💤 Low valueOptional: Consider grouping metadata fields for improved readability.
The
bugs,repository,homepage, andfundingfields 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 aligningbugsmetadata across the monorepo packagesIn
packages/*/package.json, onlypackages/query-core/package.jsoncontains 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
📒 Files selected for processing (1)
packages/query-core/package.json
Adds missing
bugsmetadata topackages/query-core/package.json.Fixes npm tooling unable to resolve package metadata.
Summary by CodeRabbit