feat!: update dep, TS arg validation, stricter internal TS #242
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
BREAKING CHANGE: slightly different validation error output. Validation rules may have changed slightly too
BREAKING CHANGE: no longer include the type of the provided filepathOrObject arg as the user already knows what the type is, and we're about to provide TypeScript hints anyway Also minor refactor in openapi-validator and using TypeScript properly
Also refactor: use TypeScript properly in jest-openapi
Also refactor: use TypeScript properly in chai plugin
Codecov Report
@@ Coverage Diff @@
## master #242 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 17 17
Lines 394 421 +27
Branches 49 58 +9
=========================================
+ Hits 394 421 +27
Continue to review full report at Codecov.
|
rwalle61
force-pushed
the
typescript-no-implicit-any
branch
2 times, most recently
from
cfd305b to
031ff9e
Compare
Although TypeScript users won't need this because the argument is now typed, it is still useful for JavaScript users
rwalle61
force-pushed
the
typescript-no-implicit-any
branch
from
031ff9e to
8141cf9
Compare
rwalle61
changed the title
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.
feat: improve Typescript hints for the
filepathOrObjectargrefactor: much stricter internal use of TypeScript
BREAKING CHANGE: this updates our validation dependency by 2 major versions, so validation error messages (and maybe validation rules) are slightly different. For example,
res did not satisfy it because: property1 should be string, property2 should be stringis nowres did not satisfy it because: property1 must be string, property2 must be string(should->must). We expect our users to read these error messages during testing but not assert on them, such that this change shouldn't break anyone's existing tests. Moreover, renamingshouldtomustdoes not indicate that the validation rule has changed. However, it is possible that other validation rules have changed