generated from sapphiredev/sapphire-template
-
-
Notifications
You must be signed in to change notification settings - Fork 13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(*)!: add custom message options to all shapes, validators and constraints #231
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #231 +/- ##
==========================================
+ Coverage 96.54% 99.68% +3.14%
==========================================
Files 61 59 -2
Lines 3592 3870 +278
Branches 375 801 +426
==========================================
+ Hits 3468 3858 +390
+ Misses 116 4 -112
Partials 8 8
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
favna
force-pushed
the
feat/custom-error-messages
branch
2 times, most recently
from
January 17, 2023 10:28
b10b28f
to
f3488bf
Compare
vladfrangu
reviewed
Jan 19, 2023
favna
force-pushed
the
feat/custom-error-messages
branch
4 times, most recently
from
April 10, 2023 15:16
c6c7d8f
to
4841101
Compare
favna
force-pushed
the
feat/custom-error-messages
branch
from
August 31, 2023 09:14
3596183
to
572ea9b
Compare
favna
force-pushed
the
feat/custom-error-messages
branch
from
May 1, 2024 10:56
64e34ff
to
ef07dab
Compare
favna
changed the title
refactor(*): Add custom message options to all shapes and validators
refactor(*): add custom message options to all shapes, validators and constraints
May 2, 2024
favna
force-pushed
the
feat/custom-error-messages
branch
2 times, most recently
from
May 9, 2024 13:13
5e07979
to
6e01235
Compare
vladfrangu
previously approved these changes
May 9, 2024
imranbarbhuiya
approved these changes
May 9, 2024
- ci: add codecov file and update testing config - refactor: pass options down to all methods and update error names - ci: fix testing in workflow - fix: fix tuple shape - test: update all existing tests to pass again - test: change magic number for constant - ci: ensure tests can run in parallel with builds - ci: change to yarnpkg registry - ci: fix test parallelization - test: output coverage as cobertura instead of clover - chore: create patch out of changes for `esbuild-plugins-node-modules-polyfill` - chore: cleanup package.json - feat: pass options through to everything - refactor: use original type location - fix: add validator options to when - fix: fixed argument order for cloning union validator - docs: expand breaking changes list - refactor: make `BaseValidator.validatorOptions` protected BREAKING CHANGE: Most shapes and validators that were previously getters are now functions to allow for custom options. The following list should show all of the changes, but if we have forgot any and you get an error saying something should be a function where you have provided a constant it is safe to assume you simply need to add `()` to your code for it to work again. BREAKING CHANGE: `NonNullObject` utility type has been removed. BREAKING CHANGE: `PickDefined` utility type has been removed. BREAKING CHANGE: `PickUndefinedMakeOptional` utility type has been removed. BREAKING CHANGE: `s.any` is now `s.any()` to allow for custom options as argument. BREAKING CHANGE: `s.array.unique` is now `s.array.unique()` to allow for custom options as second argument. BREAKING CHANGE: `s.array` is now `s.array()` to allow for custom options as argument. BREAKING CHANGE: `s.bigint().abs` is now `s.bigint().abs()` to allow for custom options as second argument. BREAKING CHANGE: `s.bigint().negative` is now `s.bigint().negative()` to allow for custom options as second argument. BREAKING CHANGE: `s.bigint().positive` is now `s.bigint().positive()` to allow for custom options as second argument. BREAKING CHANGE: `s.bigint` is now `s.bigint()` to allow for custom options as argument. BREAKING CHANGE: `s.bigInt64Array` is now `s.bigInt64Array()` to allow for custom options as argument. BREAKING CHANGE: `s.bigUint64Array` is now `s.bigUint64Array()` to allow for custom options as argument. BREAKING CHANGE: `s.boolean.false` is now `s.boolean().false()` to allow for custom options as second argument. BREAKING CHANGE: `s.boolean.true` is now `s.boolean().true()` to allow for custom options as second argument. BREAKING CHANGE: `s.boolean` is now `s.boolean()` to allow for custom options as argument. BREAKING CHANGE: `s.date.invalid` is now `s.date().invalid()` to allow for custom options as second argument. BREAKING CHANGE: `s.date.valid` is now `s.date().valid()` to allow for custom options as second argument. BREAKING CHANGE: `s.date` is now `s.date()` to allow for custom options as argument. BREAKING CHANGE: `s.enum(1, 2, 3)` is now `s.enum([1, 2, 3])` to allow for custom options as second argument. BREAKING CHANGE: `s.float32Array` is now `s.float32Array()` to allow for custom options as argument. BREAKING CHANGE: `s.float64Array` is now `s.float64Array()` to allow for custom options as argument. BREAKING CHANGE: `s.int16Array` is now `s.int16Array()` to allow for custom options as argument. BREAKING CHANGE: `s.int32Array` is now `s.int32Array()` to allow for custom options as argument. BREAKING CHANGE: `s.int8Array` is now `s.int8Array()` to allow for custom options as argument. BREAKING CHANGE: `s.never` is now `s.never()` to allow for custom options as argument. BREAKING CHANGE: `s.null` is now `s.null()` to allow for custom options as argument. BREAKING CHANGE: `s.nullable` is now `s.nullable()` to allow for custom options as argument. BREAKING CHANGE: `s.nullish` is now `s.nullish()` to allow for custom options as argument. BREAKING CHANGE: `s.nullish` is now `s.nullish()` to allow for custom options as argument. BREAKING CHANGE: `s.number.abs` is now `s.number().abs()` to allow for custom options as argument. BREAKING CHANGE: `s.number.ceil` is now `s.number().ceil()` to allow for custom options as argument. BREAKING CHANGE: `s.number.finite` is now `s.number().finite()` to allow for custom options as argument. BREAKING CHANGE: `s.number.floor` is now `s.number().floor()` to allow for custom options as argument. BREAKING CHANGE: `s.number.fround` is now `s.number().fround()` to allow for custom options as argument. BREAKING CHANGE: `s.number.int` is now `s.number().int()` to allow for custom options as argument. BREAKING CHANGE: `s.number.negative` is now `s.number().negative()` to allow for custom options as argument. BREAKING CHANGE: `s.number.positive` is now `s.number().positive()` to allow for custom options as argument. BREAKING CHANGE: `s.number.round` is now `s.number().round()` to allow for custom options as argument. BREAKING CHANGE: `s.number.safeInt` is now `s.number().safeInt()` to allow for custom options as argument. BREAKING CHANGE: `s.number.sign` is now `s.number().sign()` to allow for custom options as argument. BREAKING CHANGE: `s.number.trunc` is now `s.number().trunc()` to allow for custom options as argument. BREAKING CHANGE: `s.number` is now `s.number()` to allow for custom options as argument. BREAKING CHANGE: `s.object.ignore` is now `s.object().ignore()` to allow for custom options as argument. BREAKING CHANGE: `s.object.partial` is now `s.object().partial()` to allow for custom options as argument. BREAKING CHANGE: `s.object.passthrough` is now `s.object().passthrough()` to allow for custom options as argument. BREAKING CHANGE: `s.object.required` is now `s.object().required()` to allow for custom options as argument. BREAKING CHANGE: `s.object.strict` is now `s.object().strict()` to allow for custom options as argument. BREAKING CHANGE: `s.optional` is now `s.optional()` to allow for custom options as argument. BREAKING CHANGE: `s.set` is now `s.set()` to allow for custom options as argument. BREAKING CHANGE: `s.string.date` is now `s.string().date()` to allow for custom options as argument. BREAKING CHANGE: `s.string.email` is now `s.string().email()` to allow for custom options as argument. BREAKING CHANGE: `s.string.ipv4` is now `s.string().ipv4()` to allow for custom options as argument. BREAKING CHANGE: `s.string.ipv6` is now `s.string().ipv6()` to allow for custom options as argument. BREAKING CHANGE: `s.string` is now `s.string()` to allow for custom options as argument. BREAKING CHANGE: `s.tuple(1, 2, 3)` is now `s.tuple([1, 2, 3])` to allow for custom options as second argument. BREAKING CHANGE: `s.uint16Array` is now `s.uint16Array()` to allow for custom options as argument. BREAKING CHANGE: `s.uint32Array` is now `s.uint32Array()` to allow for custom options as argument. BREAKING CHANGE: `s.uint8Array` is now `s.uint8Array()` to allow for custom options as argument. BREAKING CHANGE: `s.uint8ClampedArray` is now `s.uint8ClampedArray()` to allow for custom options as argument. BREAKING CHANGE: `s.undefined` is now `s.undefined()` to allow for custom options as argument. BREAKING CHANGE: `s.union(1, 2, 3)` is now `s.union([1, 2, 3])` to allow for custom options as second argument. BREAKING CHANGE: `s.unknown` is now `s.unknown()` to allow for custom options as argument. BREAKING CHANGE: `uniqueArray` is now a function (instead of a constant) to allow for custom options as argument.
favna
force-pushed
the
feat/custom-error-messages
branch
from
May 20, 2024 14:48
6e01235
to
e1879be
Compare
favna
changed the title
refactor(*): add custom message options to all shapes, validators and constraints
feat(*)!: add custom message options to all shapes, validators and constraints
May 20, 2024
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.
Important
This is a very very breaking change. A document to upgrade from v3 to v4 has been provided. For review a thorough analysis is required to verify that the custom message is available everywhere.
Old content
Breaking changes are tracked in
BREAKING_CHANGES.md
until the PR is ready for merging. The file has to be removed prior to merging this PR.s.string.url
ands.string.uuid
covering the varying types of options that they supportesbuild-plugins-node-modules-polyfill
once @imranbarbhuiya merges and releases fix: fixed node14 support imranbarbhuiya/esbuild-plugins-node-modules-polyfill#51BREAKING_CHANGES.md
Breaking changes list for merge body: