enhancement bcherny#543 - Prefix items support #574
Conversation
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
added `--usePrefixItems` cli argument. When passed, JSON schemata containing `prefixItems` tuple validation key will parsed correctly.
Function isArrayType() should return true when `prefixItems` is present, even without `items` key
Added `usePrefixItems` option, which defaults to false
Created new test case
bcherny
requested changes
Mar 2, 2024
There was a problem hiding this comment.
Thanks for the contribution!
A few small nits. Please also add an e2e test, similar to https://github.com/bcherny/json-schema-to-typescript/blob/master/test/e2e/options.unreachableDefinitions.ts.
At some point we should explicitly add a --jsonSchemaVersion flag, but this is a good stop-gap for now.
Thanks!
| rules.forEach(rule => traverse(rootSchema, (schema, key) => rule(schema, filename, options, key, dereferencedPaths))) | ||
| return rootSchema as NormalizedJSONSchema | ||
| } | ||
| /* eslint-disable prettier/prettier */ |
|
|
||
| rules.set('Rename `prefixItems` to `items` and `items` to `additionallItems`', (schema, _, options) => { | ||
| if (isArrayType(schema) && options.usePrefixItems) { | ||
| // @ts-expect-error this is a simple renaming procedure, there is in no need to change the `schema.items` type to allow for boolean values |
There was a problem hiding this comment.
Please don't expect an error. Instead, make the types safer or use a type assertion (a as A).
| schema.items = schema.prefixItems | ||
| delete schema.prefixItems | ||
| } | ||
| return |
|
@TheoAnastasiadis Any chance you are still able to work on this? I would find this really helpful for my project. Thanks! |
|
Forgot about this completely. Will hopefully be free this weekend and I'll make the requested changes 🤞🤞 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added optional
--usePrefixItemsflag that defaults to false.When passed JSON schemas containing
prefixItemsanditemskeys are normalized asitemsandadditionalItems, as per JSON Schema Draft 2020-12.The draft also contains changes to the
$recursiveRefand$recursiveAnchorkeywords, which this PR does not deal with.✔Tests added