[rush] "globalCatalogs" is not defined in json schema

Open Beginner friendly
#5,839 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript
Domain
tooling

Research direction

Start with libraries/rush-lib/src/schemas/pnpm-config.schema.json and compare it with the published v5 schema at developer.microsoft.com/json-schemas/rush/v5/pnpm-config.schema.json. Update the published schema so globalCatalogs is recognized, then verify that VS Code no longer warns for pnpm-config.json#globalCatalogs.

Written by the indexing model from the issue text.

Description

Summary

https://developer.microsoft.com/json-schemas/rush/v5/pnpm-config.schema.json doesn't define "globalCatalogs"

This causes my repo's common/config/rush/pnpm-config.json which uses "globalCatalogs" to show a warning "Property globalCatalogs is not allowed." in VS Code.

Image

However, "globalCatalogs" is actually supported (even though not well-documented)

I saw it has been defined in https://github.com/microsoft/rushstack/blob/dbf9c5d63ba24bd6225474c0bab1b5c410cca13b/libraries/rush-lib/src/schemas/pnpm-config.schema.json#L284-L295

The issue here is just that the file hasn't been uploaded to https://developer.microsoft.com/json-schemas/rush/v5/pnpm-config.schema.json

Repro steps

Expected result: No warning in pnpm-config.json#globalCatalogs

Actual result: Warning in pnpm-config.json#globalCatalogs even though it is actually supported

Details

Suggestion: someone with upload permission should update https://developer.microsoft.com/json-schemas/rush/v5/pnpm-config.schema.json with the latest schema defined in https://github.com/microsoft/rushstack/blob/dbf9c5d63ba24bd6225474c0bab1b5c410cca13b/libraries/rush-lib/src/schemas/pnpm-config.schema.json#L284-L295

Standard questions

Please answer these questions to help us investigate your issue more quickly:

Question Answer
@microsoft/rush globally installed version? 5.169.3
rushVersion from rush.json? 5.164.0
pnpmVersion, npmVersion, or yarnVersion from rush.json? pnpm@10.33.0
(if pnpm) useWorkspaces from pnpm-config.json? true
Operating system? Mac
Would you consider contributing a PR? Yes
Node.js version (node -v)? v22.22.1
Dominant language
TypeScript
Stars
6.5k
Forks
708
Avg merge
5d 7h
Merged PRs (30d)
44

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/rushstack

All issues in microsoft/rushstack

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.