Output warning in JSON generator if an unmatched argument is found in descriptor.json#1467
Open
rcjsuen wants to merge 1 commit intonodegit:masterfrom
Open
Output warning in JSON generator if an unmatched argument is found in descriptor.json#1467rcjsuen wants to merge 1 commit intonodegit:masterfrom
rcjsuen wants to merge 1 commit intonodegit:masterfrom
Conversation
When making additions to the NodeGit API, it is necessary to make changes to the descriptor.json. Small typos can cause the generated code to not match the expected output. We should generate a warning if an argument name used in descriptor.json does not match the name in the C function. This will help make it a lot easier to discover problems in the handwritten descriptor.json file. Signed-off-by: Remy Suen <[email protected]>
This was referenced Mar 20, 2018
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
When making additions or changes to NodeGit to match libgit2, we have to make changes to the
generate/input/descriptor.jsonfile. If we make a typo, it goes completely undetected until your test code fails or you when you manually inspect the generated C++ code. To make this feedback loop better, we should generate a warning if an argument name used in the descriptor does not match the namein the C function. This fixes #1464 and will make everyone's lives a lot easier when adding new API to NodeGit.
The following is the new output from Travis CI.