timrs2998/graphql-for-vscode

Graphql For VSCode

VSCode extension for GraphQL schema authoring & consumption.

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.
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.
Schema Validation: The plugin also validates your schema, so that you catch errors early.
Great Syntax Highlighting: Now, your gql files will look as beautiful as the rest of your code with an awesome syntax highlighter which works not just with your schema files, but also within your Javascript/Typescript files.
Linting: This plugin uses a similar method as used by the Codemirror graphql project for linting.
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

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"
}
```
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.
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.

To enable autocomplete support within your JS(X)/TS(X) files, and even your gherkin feature files, add these lines to your .gqlconfig file:

/* .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',
        parser: ['EmbeddedQueryParser', { startTag: 'Relay\\.QL`', endTag: '`' }],
        isRelay: true,
      },
      {
        match: 'features/**/*.feature',
        parser: ['EmbeddedQueryParser', { startTag: 'graphql request\\s+"""', endTag: '"""' }],
      },
      {
        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!

timrs2998 / graphql-for-vscode