Allow required, description, and enum to be regular fields if their types are wrong #51
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 6 commits
October 27, 2022 08:39
…names (enum, required, description)
James1x0
reviewed
Dec 13, 2022
| const metaValue = value[metaProp]; | ||
| const isValidEnum = metaProps === 'enum' ? Array.isArray(metaValue) : true; | ||
| const isValidRequired = metaProps === 'required' ? Array.isArray(metaValue) || typeof metaValue === 'boolean' : true; | ||
| const isValidDescription = metaProps === 'description' ? typeof metaValue === 'string' : true; |
There was a problem hiding this comment.
@JulianKingman Wouldn't a more succinct way to address validity of meta props be to check the non-existence of { type }? This is how mongoose requires overrides of meta props in schema definitions.
enum: '' // meta
enum: { type: something } // your field
James1x0
reviewed
Dec 13, 2022
| @@ -1,6 +1,6 @@ | |||
| { | |||
| "name": "mongoose-to-swagger", | |||
| "version": "1.5.0", | |||
| "version": "1.5.1", | |||
There was a problem hiding this comment.
Don't bump patch versions for lib maintainers 🙏
James1x0
reviewed
Dec 13, 2022
Comment on lines
+47
to
+48
| "prepublish": "npm run build", | ||
| "preinstall": "npm run build" |
There was a problem hiding this comment.
Suggested change
| "prepublish": "npm run build", | |
| "preinstall": "npm run build" | |
| "prepublish": "npm run build" |
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.
Would you accept this PR if I added some tests and removed the preinstall step?
The idea here is to not set the meta fields unless they're of a type that it's expecting, effectively allowing mongoose fields called
required,description(quite common), orenum.I'm not 100% sure this is the best way to do it, but it works 🤷
This would fix this issue: #36