Improve exercise generator #1797
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
When the generator was created, it lived in the same crate as other rust code unrelated to exercise generation. Therefore, a split between library and executable was natural. (also naming the executable, instead of a simple main.rs) Now that exercise generation has its own crate, the split between library and executable doesn't make sense anymore.
The difficulty of an exercise was until now represented as a `u8`, even though it was only allowed to be 1, 4, 7, or 10. By representing the difficulty as an enum, which de-/serializes to and from an integer as expected, we have full type safety and can get rid of the tests. If there was an invalid difficulty in the config, the test which deserializes the entire config would fail already.
For example for custom exercises which do not come from problem-specifications.
Usually when rustfmt fails, it is because the tera template produces invalid syntax. For generated test cases, this usually means all test cases are invalid, so there are a lot of practically identical errors.
|
Apart from a few internal refactorings I'm quite happy about, the main win here for me is the fact that one can run just update-exercise --slug accumulateto synchronize an exercise without any further interactive prompts. Until now, one would always be prompted for the exercise slug interactively. When I'm tweaking an exercise's test template, I run the generator very often and it can get tedious to enter the slug interactively every time. |
ErikSchierboom
approved these changes
Nov 23, 2023
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.
Add a clap-based CLI
All user-input can now be entered upfront with cli flags
or later by being prompted for it interactively.
Limit output of rustfmt passed onto user
(There are usually many duplicates when generating test cases.)
Handle absence of canonical data
(e.g. for custom exercises) not from problem-specifications)
piggyback: