chore(sca): add comments to manifest kinds #305
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
|
Backwards compatibility summary: |
bkettle
force-pushed
the
bk/ddr/add-comments-to-manifest-kind
branch
from
cc69438 to
8669f34
Compare
aryx
reviewed
Oct 31, 2024
| (* TODO: merge with Manifest_kind.ml *) | ||
| type manifest_kind <python decorator="dataclass(frozen=True)"> = [ | ||
| | RequirementsIn (* Manifest file for pip *) | ||
| type manifest_kind |
There was a problem hiding this comment.
@mjambon what do we need to add to generate proper Variant like RequirementsIn instead of the `RequirementsIn in the generated OCaml code?
There was a problem hiding this comment.
Hmm, it looks like that might even be supported today with <ocaml repr="classic">: https://atd.readthedocs.io/en/latest/atdgen.html#sum-types
Do you think I should switch this one over?
There was a problem hiding this comment.
I prefer yes. They are simpler to handle.
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.
In order to consolidate the
manifest_kindtype in interfaces withManifest_kind.ml, this PR:transfers the comments from the ML file to interfaces
adds
eq,show, andyojsonderivations to the ATD definitionI ran
make setup && maketo update the generated code after editing a.atdfile (TODO: have a CI check)I made sure we're still backward compatible with old versions of the CLI.
For example, the Semgrep backend need to still be able to consume data generated
by Semgrep 1.17.0.
See https://atd.readthedocs.io/en/latest/atdgen-tutorial.html#smooth-protocol-upgrades