WIP: Fix JS Doc comments in Vue Apollo queries #3715
Closed
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.
Currently, because of the
type
declaration placed before the exported function in queries, it does not pick up the JSDoc docstring:Adding
@param variables
and moving thetype
below the function makes it work properly:I am unable to test these changes properly because I wasn't able to find documentation on the development workflow for modifying existing plugins.
I tried running the
build
script from the main repo and using theindex.cjs.js
, but during the codegen process it errors due to there being "duplicate copies of graphql library":