fix(functions): schema should respect "auto" dialect #1771
Merged
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
P0lip
commented
Aug 16, 2021
| @@ -25,11 +25,13 @@ export default createRulesetFunction<unknown, Options>( | |||
| }, | |||
| dialect: { | |||
| enum: ['auto', 'draft4', 'draft6', 'draft7', 'draft2019-09', 'draft2020-12'], | |||
| default: 'auto', | |||
There was a problem hiding this comment.
unrelated, but I thought it'd be actually cool to express what the default is.
Going to be useful later on in Studio when building forms.
P0lip
commented
Aug 16, 2021
| @@ -56,7 +58,9 @@ export default createRulesetFunction<unknown, Options>( | |||
|
|
|||
| try { | |||
| let validator; | |||
| const dialect = opts?.dialect ?? detectDialect(schemaObj) ?? 'draft7'; | |||
| const dialect = | |||
There was a problem hiding this comment.
this is the only actual change
lottamus
approved these changes
Aug 16, 2021
| }, | ||
| prepareResults: {}, | ||
| prepareResults: true, |
There was a problem hiding this comment.
I'm assuming this is the same as passing an empty object?
| @@ -56,7 +58,9 @@ export default createRulesetFunction<unknown, Options>( | |||
|
|
|||
| try { | |||
| let validator; | |||
| const dialect = opts?.dialect ?? detectDialect(schemaObj) ?? 'draft7'; | |||
| const dialect = | |||
| (opts.dialect === void 0 || opts.dialect === 'auto' ? detectDialect(schemaObj) : opts?.dialect) ?? 'draft7'; | |||
There was a problem hiding this comment.
If opts is not defined, it will throw on L56
Suggested change
| (opts.dialect === void 0 || opts.dialect === 'auto' ? detectDialect(schemaObj) : opts?.dialect) ?? 'draft7'; | |
| (opts.dialect === void 0 || opts.dialect === 'auto' ? detectDialect(schemaObj) : opts.dialect) ?? 'draft7'; |
stoplight-bot
pushed a commit
that referenced
this pull request
Aug 17, 2021
# [@stoplight/spectral-functions-v1.1.2](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-functions-v1.1.1...@stoplight/spectral-functions-v1.1.2) (2021-08-17) ### Bug Fixes * **functions:** schema should respect "auto" dialect ([#1771](#1771)) ([ed1621c](ed1621c))
|
🎉 This PR is included in version @stoplight/spectral-functions-v1.1.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Currently when you pass "auto" we don't run
detectDialectfunction, so nothing useful happens.Checklist
Does this PR introduce a breaking change?