Revise Ortac/Dune to minimize yet again boilerplate #218
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
|
This PR is based on #214, please consider only the last 5 commits. |
n-osborne
force-pushed
the
revise-dune-plugin
branch
2 times, most recently
from
a8959a8
to
a1fe1cd
Compare
n-osborne
force-pushed
the
revise-dune-plugin
branch
5 times, most recently
from
1f8bc90
to
aed44fd
Compare
n-osborne
force-pushed
the
revise-dune-plugin
branch
from
aed44fd
to
506e072
Compare
n-osborne
force-pushed
the
revise-dune-plugin
branch
from
506e072
to
fa155d3
Compare
n-osborne
force-pushed
the
revise-dune-plugin
branch
from
fa155d3
to
419e4ca
Compare
n-osborne
force-pushed
the
revise-dune-plugin
branch
from
419e4ca
to
2027e09
Compare
shym
approved these changes
Jun 26, 2024
There was a problem hiding this comment.
This is really nice simplification, thank you! Now I wonder if those default names should not be adopted directly in Ortac/QCheck-STM.
- 8198b4a Remove generation of dune rule generation
I find the phrasing of the commit message unclear, isn’t a negation missing?
Suggestion: “as we want...” → “Future commits will simplify calling out directly thedune qcheck-stm” from the command line.” (even if I’m not a big fan a talking about future commits in messages, here that might be the needed context) - 9990674 Make config and test name optional
Change the commit title to names, to make it clearer the config is not optional, just its name?
I wondered whether it would be worth having tests for the case the options are actually working when explicitly set, for instance by using them in the examples to preserve the file names used before the PR?
n-osborne
force-pushed
the
revise-dune-plugin
branch
2 times, most recently
from
4665003
to
5a54e3e
Compare
shym
approved these changes
Jun 26, 2024
plugins/dune-rules/README.md
Outdated
| This stanza assumes that you have written the configuration for | ||
| [Ortac/QCheck-STM] in a file named `lib_config.ml` and that the `Lib` module is | ||
| part of the `lib` library. It will write the generated tests in `lib_tests.ml`. | ||
| If you want more control, you can use the `--config` `--library` and `--output` |
There was a problem hiding this comment.
Suggested change
| If you want more control, you can use the `--config` `--library` and `--output` | |
| If you want more control, you can use the `--config`, `--library` and `--output` |
This comma sliped in the revision, I think :-)
plugins/dune-rules/src/dune_rules.ml
Outdated
Comment on lines
29
to
30
| "Concatenation of INTERFACE without the extension and \ | ||
| \"_config.ml\"." |
There was a problem hiding this comment.
Given how the ~absent field is rendered, I think I would prefer no initial capital and no ending period.
Suggested change
| "Concatenation of INTERFACE without the extension and \ | |
| \"_config.ml\"." | |
| "concatenation of INTERFACE without the extension and \ | |
| \"_config.ml\"" |
n-osborne
force-pushed
the
revise-dune-plugin
branch
from
5a54e3e
to
bd20450
Compare
The generated dune rules no longer generate the rule to generate themselves. Future commits will simplify calling out directly the dune qcheck-stm.
When the argument is missing, Ortac/Dune will assume that the library has the same name as the module.
The normalisation concerns only the dune and the qcheck-stm plugins for now.
n-osborne
force-pushed
the
revise-dune-plugin
branch
from
bd20450
to
88f8636
Compare
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.
This PR proposes to:
_config_tests].mlIn the best case scenario, this allows to just write: