GraphQL syntax highlighting, linting, auto-complete, and more!
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.vscode chore(tasks): fix vscode tasks Nov 14, 2017
extras chore(project): replace svg with png due to vscode changes Jul 5, 2017
images chore(project): replace svg with png due to vscode changes Jul 5, 2017
scripts chore(release): upgrade release process Apr 30, 2018
snippets refactor: move server & client into same folder Dec 25, 2016
src chore(code): add tslint Sep 20, 2017
syntaxes fix(syntax): fix blockstring description syntax, add some sample files Jul 29, 2018
test fix(syntax): fix blockstring description syntax, add some sample files Jul 29, 2018
.editorconfig chore(code): add editorconfig, enforce LF line endings Sep 12, 2017
.gitattributes chore(code): add editorconfig, enforce LF line endings Sep 12, 2017
.gitignore chore(release): upgrade release process Apr 30, 2018
.releaserc fix(release): fix changelogs generation on release May 2, 2018
.travis.yml chore(release): upgrade release process Apr 30, 2018
.vscodeignore chore(code): add editorconfig, enforce LF line endings Sep 12, 2017
CHANGELOG.md ci(release): update changelog [skip ci] Jul 29, 2018
License.txt chore(code): add editorconfig, enforce LF line endings Sep 12, 2017
README.md docs(readme): add markdown in syntax highlighting Jun 7, 2018
ThirdPartyNotices.txt chore(code): add editorconfig, enforce LF line endings Sep 12, 2017
package.json docs(readme): add markdown in syntax highlighting Jun 7, 2018
tslint.json chore(code): add tslint Sep 20, 2017
typings.json Fix building with latest TS Sep 19, 2017
yarn.lock fix(release): fix changelogs generation on release May 2, 2018

README.md

Logo

Graphql For VSCode

Latest Release Installs Rating

Semantic Release Greenkeeper badge


VSCode extension for GraphQL schema authoring & consumption.

A preview of the extension

What's in the Box?

  • Go to Definition: Just F12 or Ctrl+Click on any graphql type, and you'll jump right to it's definition.

    Go to Definition

  • Autocomplete: Uses the @playlyfe/gql library to read your whole graphql schema definitions and provide you with autocomplete support while writing & editing your .gql files.

    Autocomplete

  • Schema Validation: The plugin also validates your schema, so that you catch errors early.

  • Linting: This plugin uses a similar method as used by the Codemirror graphql project for linting.

  • Great Syntax Highlighting: Now, your graphql queries, mutations and gql files will look as beautiful as the rest of your code with an awesome syntax highlighter. It works not just with your .gql/.graphql schema files, but also within your code - supports syntax highlighting within:

    • Javascript
    • Typescript
    • Vue
    • Ruby
    • Cucumber
    • ReasonML/OCaml
    • Markdown fenced code-blocks
    • (Submit a PR to support your language!)
  • Snippets: Some commonly used snippets are provided which help while writing mutations and queries, such as defining types, interfaces and input types.

Setting it Up

  1. Ensure that you have the @playlyfe/gql library (v2.x) installed and available to this plugin. If you've installed the library in a folder other than the workspace root, then add the path to the node_modules directory as a setting:

    {
      "graphqlForVSCode.nodePath": "ui/node_modules"
    }
  2. Ensure you have watchman installed and available in your path. Watchman watches your gql files and provides up-to-date suggestions. For users on Windows, get the latest build mentioned in this issue and add the location of watchman.exe to your environment path.

  3. Create a .gqlconfig file (required by the @playlyfe/gql package).

    A minimal example:

    The .gqlconfig is a JSON file with only one required key: schema.files which is the path to your *.gql files relative to your workspace root.

    /* .gqlconfig */
    {
      schema: {
        files: 'schemas/**/*.gql'
      }
    }

    You can use the string files: "**/*.gql" instead if you want to find any .gql file recursively in the workspace dir.

    To see the full configuration, check out the GQL project's docs.

  4. To enable autocomplete support within your code, add these lines to your .gqlconfig file. The query section of the config contains an array of file config with matchers. You can add more files by directing the EmbeddedQueryParser to run when your code within the startTag and endTag matches:

    /* .gqlconfig */
    {
      schema: {
        files: "schemas/**/*.gql"
      },
      query: {
        files: [ /* define file paths which you'd like the gql parser to watch and give autocomplete suggestions for */
          {
            match: 'ui/src/**/*.js', // for js
            parser: ['EmbeddedQueryParser', { startTag: 'Relay\\.QL`', endTag: '`' }],
            isRelay: true,
          },
          {
            match: 'features/**/*.feature', // for gherkin
            parser: ['EmbeddedQueryParser', { startTag: 'graphql request\\s+"""', endTag: '"""' }],
          },
          {
            "match": "lib/**/*.rb", // sample config you might use for Ruby-aware highlighting (inside `<<-GRAPHQL` heredocs)
            "parser": ["EmbeddedQueryParser", { "startTag": "<<-GRAPHQL", "endTag": "GRAPHQL" }]
          },
          {
            match: 'fixtures/**/*.gql',
            parser: 'QueryParser',
          },
        ],
      },
    }

    Again, refer to GQL docs for details about configuring your .gqlconfig.

Future Plans

  • Tests: Figure out tests.

Contributing

  • If you have a suggestion or a problem, please open an issue.
  • If you'd like to improve the extension:
    • If you've made any improvements to the extension, send a Pull Request!
    • The instructions to run the server are here
    • The instructions to run and debug the client are here

Hacking

Client

If you're making changes to the client, then run npm run watch inside this directory, then just press F5 to launch the Extension Development Host instance of vscode. Whenever you make a change, press Reload to reload the EDH instance.

Server

If you're making changes to the server, then run npm run watch-server from the root directory. Then, run the client in debug mode. If you make any change in the server code, you need to reload the Extension Development Host instance of vscode.

Major Contributors

  • Mayank Agarwal - added autocomplete, goto definition, schema validation support

Changelog

  • Latest changes are available on the releases page.
  • Older changelogs can be found here.

Happy Querying!