Skip to content

Documentation: VSCode Integration; Enable lint highlighting #2857

Open
@SStranks

Description

@SStranks

Is your feature request related to a problem? Please describe.

Inadequate Documentation: VSCode Integration Page: VSCode Integration

Describe the solution you'd like

An additional statement about VSCode integration. While the vscode-graphql extensions are necessary for validation and syntax highlighting, they do not enable lint highlighting for graphql files - the @graphql-eslint/eslint-plugin functions correctly if running eslint from the CLI, and highlights linting in js/ts based files.

To enable visible linting in graphql files, you have to add the following to the VSCode settings:
"eslint.validate": ["graphql"]

I had to track down this thread to find the solution to the problem as it's not documented anywhere: Support Probing for graphql files

Given the plugin is about linting I feel the aforementioned vscode setting should be displayed on the documentation page as a note.

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