redhat-developer / redhat-developer/vscode-yaml
`pnpm-workspace.yaml` Schema Outdated: `onlyBuiltDependencies` (pnpm v10.5.0+) Invalid
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 829
- Forks
- 260
- Avg merge
- 5h 43m
- Merged PRs (30d)
- 1
Description
Describe the bug
The YAML schema validation for pnpm-workspace.yaml is incorrectly flagging the onlyBuiltDependencies property as invalid, resulting in the following error:
Property onlyBuiltDependencies is not allowed.yaml-schema: pnpm Workspace (pnpm-workspace.yaml)(513)
However, the onlyBuiltDependencies field was officially introduced in pnpm v10.5.0 as a valid configuration option within pnpm-workspace.yaml. See the release notes: https://github.com/pnpm/pnpm/releases/tag/v10.5.0
This suggests that the schema used by the extension is outdated and needs to be updated to reflect the latest pnpm specifications. This is causing false-positive errors for users who are legitimately using this feature.
Additionally, it appears that ignoreBuiltDependencies is also a valid (though undocumented) option in pnpm-workspace.yaml. The schema should be updated to include this property as well, if confirmed to be part of the official (even if undocumented) pnpm API.
Expected Behavior
The onlyBuiltDependencies property within pnpm-workspace.yaml should be recognized as a valid property, and no error should be reported. The extension should provide autocompletion and validation consistent with the pnpm v10.5.0+ schema.
Current Behavior
The extension reports "Property onlyBuiltDependencies is not allowed" for the onlyBuiltDependencies property in pnpm-workspace.yaml. This is an incorrect error.
Steps to Reproduce
-
Create or open a
pnpm-workspace.yamlfile. -
Add the
onlyBuiltDependenciesproperty to the file, for example:packages: - packages/* onlyBuiltDependencies: - esbuild - fuse-native -
Observe the error message reported by the YAML extension.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No source file or test is named in the issue. Start by locating the pnpm-workspace.yaml schema definition and its validation or completion tests; confirm the supported pnpm options against the v10.5.0 release notes. Done means both properties are accepted without errors and available through completion, with tests covering the behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript, yaml
- Domain
- developer-experience, tooling
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100