-
-
Notifications
You must be signed in to change notification settings - Fork 5
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
Replace schema traits with interface constants #485
Merged
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 Report
@@ Coverage Diff @@
## master #485 +/- ##
============================================
- Coverage 99.95% 99.95% -0.01%
+ Complexity 934 927 -7
============================================
Files 108 107 -1
Lines 2299 2280 -19
============================================
- Hits 2298 2279 -19
Misses 1 1
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
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.
The reason the schema traits were introduced was to clearly separate and define the recognized front matter options, however having it in a trait doesn't really make too much sense as they are not intended for direct reuse, but instead as a a static reference, and since they shouldn't change, why not have them as constants, and why not have those constants in an interface? It's something I only recently realized works, so let's try it out.
The schema traits were an experiment to begin with, and removing them will reduce a lot of complexity and extra code that is not needed. I'm also removing the inline documentation, as the schemas should be stable and not change a lot, and if a property needs to be explained to be understandable, it might need renaming anyways.
A large problem with using the traits for schemas is that they define the internal data type, which may not correspond with the front matter version. For example, an author is always internally parsed into an Author model, but to define one you either need to use a string or array in the front matter.