Repository navigation
feat: display expected constant for const validation errors (#162) - #340
Open
utkarshpatwa393-sys wants to merge 1 commit into
Open
utkarshpatwa393-sys wants to merge 1 commit into
utkarshpatwa393-sys wants to merge 1 commit into
Conversation
…n#162) Signed-off-by: Utkarsh patwa <utkarshpatwa393@gmail.com>
🦋 Changeset detectedLatest commit: 7411b46 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Author
This branch has not been deployed
This file contains hidden or 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
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.
Summary
Resolves #162.
When an Ajv schema specifies
const: "foo"and validation fails on a mismatch, Ajv providesparams: { allowedValue: "foo" }. Previously,better-ajv-errorsdid not handle theconstkeyword specifically, falling back toDefaultValidationErrorwhich output generic text:const must be equal to constantwithout showing what the expected constant value was.Changes
src/types.ts):ConstParamstype ({ allowedValue: unknown }).src/utils.ts,src/helpers.ts):isConstErrortype guard.consterrors into enum bucket and routed them throughEnumValidationErrorwithallowedValues: [error.params.allowedValue].src/validation-errors/enum.ts):constkeyword to renderCONSTheader (instead ofENUM).CONST must be equal to constant (<allowedValue>)and provides fallback pointer messageUnexpected value, should be equal to constant <allowedValue>or Levenshtein suggestion if closest match found.src/__tests__/index.tsverifying CLI and JS formatted error outputs..changeset/const-error-display.md.