Fix omitVersions config parsing and documentation #637
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes several issues with the
omitVersionsfeature that were preventing it from working correctly with config files and causing documentation inconsistencies.Issues Fixed
1. Missing Config Schema Field
The
omitVersionsfield was missing from the config schema inschema.ts, which meant it couldn't be parsed from config files. Users could only use the CLI flag--omit-versionsbut not configure it in their config files.2. Documentation Inconsistencies
"omitVersion"(singular) instead of the correct"omitVersions"(plural)--omit-versionsflag entirelyomitVersionsoption3. Testing Coverage
No end-to-end tests existed to validate that the
omitVersionsconfig file parsing worked correctly.Changes Made
omitVersionsto config schema - Users can now use"omitVersions": true/falsein their config files"omitVersion"to"omitVersions"--omit-versionsflag with usage examplesomitVersionsexamples in JSON, YAML, and JavaScript formatsBefore/After Example
Before (broken):
{ "omitVersions": true // This was ignored due to missing schema }After (working):
{ "omitVersions": true // Now properly parsed and applied }The output now correctly shows package names without versions (e.g.,
dep-oneinstead of[email protected]) whenomitVersionsis enabled via config file.Fixes #635.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.