create vendorfiles.schema.json #120
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
There was a problem hiding this comment.
Pull request overview
This PR introduces a JSON Schema file for vendorfiles configuration, providing validation and autocompletion support in modern editors. The changes also include cleanup of deprecated name fields from example files and updated documentation explaining how to use the schema.
- Adds comprehensive JSON Schema definition with validation rules, examples, and documentation
- Removes obsolete
namefield from example configuration files - Reorganizes Quick Start section in README for better clarity
- Adds new JSON Schema section in documentation with usage examples
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| vendorfiles.schema.json | New comprehensive JSON Schema defining the structure, validation rules, and documentation for vendorfiles configuration files |
| examples/vendor.yml | Removed deprecated name field and normalized quote style |
| examples/vendor.toml | Removed deprecated name field |
| examples/vendor.json | Removed deprecated name field and fixed trailing whitespace |
| README.md | Reorganized Quick Start section, removed Installation heading, and added new JSON Schema documentation section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
vendorfiles.schema.json
Outdated
| "additionalProperties": false | ||
| }, | ||
| "defaultOptions": { | ||
| "type": "object", |
There was a problem hiding this comment.
The defaultOptions definition uses both type: object and $ref at the same level, which is redundant. In JSON Schema, when you use $ref, other keywords at the same level are typically ignored (though this behavior changed in later drafts). Since vendorDependency is already defined as type object, you should remove the redundant type: object line here.
| "type": "object", |
…t required fields Refactor schema to use vendorDependencyBase for shared properties, allowing defaultOptions to have all properties optional while vendorDependency requires repository and files. Also allow files to be a single string.
No description provided.