feat: Add validation plan generator #375
Merged
+1,039
−265
Conversation
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
nieomylnieja
force-pushed
the
add-validation-plan-generator
branch
from
5c9fbc5 to
3ca97a3
Compare
nieomylnieja
requested review from
skrolikiewicz and
daniel-zelazny
as code owners
skrolikiewicz
approved these changes
Apr 23, 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.
Motivation
When documenting an API it's often a struggle to keep consistency between the code and documentation we write for it.
What If your code could be self descriptive? Specifically, what If we could generate documentation out of our validation rules?
This PR explores this topic attempting to create a builtin mechanism for generating a validation plan, which could then be used to generate human-readable documentation for validation rules.
You can generate a validation plan by running:
This PR does not attempt to make the whole validation plan fully polished and ready to go, but rather create a foundation on top of which to build on at the same time proving it can be done.