-
Notifications
You must be signed in to change notification settings - Fork 97
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
Comments
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 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 https://github.com/jimkyndemeyer/js-graphql-intellij-plugin/releases 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, |
How do I install the v2 version of this plugin? |
Hi @nanandn The installation steps for v2 are included in the releases under the "Getting and installing the alpha releases" section. See https://github.com/jimkyndemeyer/js-graphql-intellij-plugin/releases/tag/2.0.0-alpha-3 for the latest release. Best regards, |
@jimkyndemeyer Thanks. Installed the update. |
@jimkyndemeyer A couple of things after the update...
|
@nanandn Please read through the documentation on schema discovery in the release link I posted earlier for you. Version 2 uses a completely different and more flexible approach. Regarding For furture reference please add your feedback to #164 I'll remove the comments here later as they don't belong in this issue. |
@jimkyndemeyer Sorry. I realized the documentation mentions the new approach after I added my comment. Reading the doc now. |
Just released https://github.com/jimkyndemeyer/js-graphql-intellij-plugin/releases/tag/2.0.0-alpha-4 with support for markdown in documentation. Best regards, |
Closing this as markdown documentation has been supported since 2.0.0-alpha-4. |
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:
And syntax highlighted as errors:
Steps to Reproduce / Link to Repo with Reproduction and Instructions
gql
template template tag fromapollo-server
gql
, and fill it with a valid GraphQL type using the standard GraphQL Schema LanguageThe text was updated successfully, but these errors were encountered: