Skip to content

Support Inline Markdown Documentation #185

@bericp1

Description

@bericp1

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions