Add a JSON schema #147
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,267 @@ | ||
| { | ||
| "$ref": "#/definitions/RcFile", | ||
| "$schema": "http://json-schema.org/draft-07/schema#", | ||
| "definitions": { | ||
| "CustomTypeConfig.Any": { | ||
| "anyOf": [ | ||
| { | ||
| "$ref": "#/definitions/CustomTypeConfig.NameAndVersionProps" | ||
| }, | ||
| { | ||
| "$ref": "#/definitions/CustomTypeConfig.NamedVersionString" | ||
| }, | ||
| { | ||
| "$ref": "#/definitions/CustomTypeConfig.UnnamedVersionString" | ||
| }, | ||
| { | ||
| "$ref": "#/definitions/CustomTypeConfig.VersionsByName" | ||
| } | ||
| ] | ||
| }, | ||
| "CustomTypeConfig.NameAndVersionProps": { | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "namePath": { | ||
| "type": "string" | ||
| }, | ||
| "path": { | ||
| "type": "string" | ||
| }, | ||
| "strategy": { | ||
| "const": "name~version", | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "namePath", | ||
| "path", | ||
| "strategy" | ||
| ], | ||
| "type": "object" | ||
| }, | ||
| "CustomTypeConfig.NamedVersionString": { | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "path": { | ||
| "type": "string" | ||
| }, | ||
| "strategy": { | ||
| "const": "name@version", | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "path", | ||
| "strategy" | ||
| ], | ||
| "type": "object" | ||
| }, | ||
| "CustomTypeConfig.UnnamedVersionString": { | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "path": { | ||
| "type": "string" | ||
| }, | ||
| "strategy": { | ||
| "const": "version", | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "path", | ||
| "strategy" | ||
| ], | ||
| "type": "object" | ||
| }, | ||
| "CustomTypeConfig.VersionsByName": { | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "path": { | ||
| "type": "string" | ||
| }, | ||
| "strategy": { | ||
| "const": "versionsByName", | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "path", | ||
| "strategy" | ||
| ], | ||
| "type": "object" | ||
| }, | ||
| "RcFile": { | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "$schema": { | ||
| "type": "string" | ||
| }, | ||
| "customTypes": { | ||
| "additionalProperties": { | ||
| "$ref": "#/definitions/CustomTypeConfig.Any" | ||
| }, | ||
| "type": "object" | ||
| }, | ||
| "dependencyTypes": { | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "type": "array" | ||
| }, | ||
| "filter": { | ||
| "type": "string" | ||
| }, | ||
| "indent": { | ||
| "type": "string" | ||
| }, | ||
| "semverGroups": { | ||
| "items": { | ||
| "$ref": "#/definitions/SemverGroupConfig.Any" | ||
| }, | ||
| "type": "array" | ||
| }, | ||
| "semverRange": { | ||
| "$ref": "#/definitions/SemverRange" | ||
| }, | ||
| "sortAz": { | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "type": "array" | ||
| }, | ||
| "sortFirst": { | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "type": "array" | ||
| }, | ||
| "source": { | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "type": "array" | ||
| }, | ||
| "versionGroups": { | ||
| "items": { | ||
| "$ref": "#/definitions/VersionGroupConfig.Any" | ||
| }, | ||
| "type": "array" | ||
| } | ||
| }, | ||
| "type": "object" | ||
| }, | ||
| "SemverGroupConfig.Any": { | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "dependencies": { | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "type": "array" | ||
| }, | ||
| "dependencyTypes": { | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "type": "array" | ||
| }, | ||
| "isIgnored": { | ||
| "const": true, | ||
| "type": "boolean" | ||
| }, | ||
| "label": { | ||
| "type": "string" | ||
| }, | ||
| "packages": { | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "type": "array" | ||
| }, | ||
| "range": { | ||
| "$ref": "#/definitions/SemverRange" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "dependencies", | ||
| "packages" | ||
| ], | ||
| "type": "object" | ||
| }, | ||
| "SemverRange": { | ||
| "default": "", | ||
| "description": "Aliases for semver range formats supported by syncpack\n\nDefaults to `\"\"` to ensure that exact dependency versions are used instead of loose ranges, but this can be overridden in your config file or via the `--semver-range` command line option.\n\n| Supported Range | Example | | --------------- | --------: | | `\"<\"` | `<1.4.2` | | `\"<=\"` | `<=1.4.2` | | `\"\"` | `1.4.2` | | `\"~\"` | `~1.4.2` | | `\"^\"` | `^1.4.2` | | `\">=\"` | `>=1.4.2` | | `\">\"` | `>1.4.2` | | `\"*\"` | `*` |", | ||
| "enum": [ | ||
| "", | ||
| "*", | ||
| ">", | ||
| ">=", | ||
| ".x", | ||
| "<", | ||
| "<=", | ||
| "^", | ||
| "~" | ||
| ], | ||
| "type": "string" | ||
| }, | ||
| "VersionGroupConfig.Any": { | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "dependencies": { | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "type": "array" | ||
| }, | ||
| "dependencyTypes": { | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "type": "array" | ||
| }, | ||
| "isBanned": { | ||
| "const": true, | ||
| "type": "boolean" | ||
| }, | ||
| "isIgnored": { | ||
| "const": true, | ||
| "type": "boolean" | ||
| }, | ||
| "label": { | ||
| "type": "string" | ||
| }, | ||
| "packages": { | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "type": "array" | ||
| }, | ||
| "pinVersion": { | ||
| "type": "string" | ||
| }, | ||
| "policy": { | ||
| "const": "sameRange", | ||
| "type": "string" | ||
| }, | ||
| "preferVersion": { | ||
| "enum": [ | ||
| "highestSemver", | ||
| "lowestSemver" | ||
| ], | ||
| "type": "string" | ||
| }, | ||
| "snapTo": { | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "type": "array" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "dependencies", | ||
| "packages" | ||
| ], | ||
| "type": "object" | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What was happening when you made this change? Maybe I can help. This doesn't seem right as
IgnoredandWithRangeare mutually exclusive but this change makes them a combination of both types added together.This comment also apples to the same change made below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ts-json-schema-generator doesn't understand the union type.
Maybe I don't understand the union correctly. It is a combination of the types right?
The Union.Strict makes sure when type is
Ignoredall other fields ofIgnoredare also required.What you want would be:
Here it is not possible to define
IgnoredandWithRangeThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hopefully this makes sense, what
Union.Strict<Ignored | WithRange>is describing is:In contrast
Ignored & WithRangeis creating one new type, which isIgnoredwith all the properties ofWithRangemerged together on top into one object.Maybe give it a try by going back to how it was but remove every usage of
Union.Strictand see if everything still works. It may be fine, but I think possibly there may be some cases where the problems linked here may come up.