New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support Inline Markdown Documentation #185

bericp1 opened this Issue Nov 7, 2018 · 1 comment


None yet
2 participants

bericp1 commented Nov 7, 2018

Version and Environment Details

Operation system: macOS High Sierra 10.13.5

IDE name and version: WebStorm 2018.2.5

Plugin version: 1.7.2

Expected Behaviour

Inline markdown comments with double quotes (single-line) and triple double quotes (multi-line) which apollo-server at least supports as a means of documenting the scheme are syntax highlighted and maybe interpreted by the plugin.

Actual Behaviour

Inline markdown comments are considered an error:

Error:(5, 3) Syntax Error GraphQL (5:3) Unexpected String

Screenshot of error: Error:(5, 3) Syntax Error GraphQL (5:3) Unexpected String

And syntax highlighted as errors:

Screenshot of syntax highlighted

Steps to Reproduce / Link to Repo with Reproduction and Instructions

  1. Create a JS file in an apollo-server project
  2. Import the gql template template tag from apollo-server
  3. Create a template literal, tag it with gql, and fill it with a valid GraphQL type using the standard GraphQL Schema Language
  4. Add a single- or multi-line comment to the type per the documentation here.

This comment has been minimized.


jimkyndemeyer commented Nov 9, 2018

Hi Brandon.

Thanks for using the plugin.

Documentation in quotes/tripe quotes was a breaking language change that was added to the GraphQL spec after the V1.x parser and language service for this plugin was built. V1 expects documentation to be in # line comments above types and fields.

V2 of this plugin follows that newer language spec, but is still work in progress. Currently V2 shows documentation in completions, but the quick documentation viewer found in V1 is yet to be built.

You can read more about V2 in #164 and and try it out if you prefer to use quotes for the documentation.

I'll keep this issue around as markdown support would be a nice addition to V2.

Best regards,

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment