Featured Plugin: JS GraphQL

Ekaterina Prigara

The JS GraphQL plugin is one the most popular plugins for WebStorm, IntelliJ IDEA, and other JetBrains IDEs, and we are very excited about the release of its second version.

In this blog post we’ll have a closer look at the updated plugin and how it can help you work with GraphQL in your JavaScript apps.

We want to thank Jim Meyer, the author of the plugin, for the amazing work he has done to build this plugin!

Working with schema files

The plugin brings full support for the GraphQL Schema Definition Language (SDL). That means your .graphql file will include syntax highlighting, and as you start typing, you will get suggestions for the keywords and built-in and custom types, as well as interfaces and enums.

Completion in schema file

Cmd/Ctrl-click the type name to navigate to its definition.

The plugin will check that all the types you’ve used are defined somewhere in the file, and it will show an error message if they’re not. Press Alt-Enter to fix the problem with one of the available quick-fixes.

Quick fix in schema file

All the familiar features like commenting, folding, brace matching, formatting, quick documentation, as well as Find usages and Rename work for the GraphQL schema language.

If your schema is described in the template string in the .js or .ts file, you can use a tagged string (const typeDefs = graphql``). Or you can press Alt-Enter and then select Inject language – GraphQL to enable coding assistance.

GraphQL in JavaScript

Working with queries and mutations

When you write GraphQL queries or mutations inside template strings in your JavaScript or TypeScript files, you will get full schema-aware code completion for types, fields, and arguments. Cmd/Ctrl-click will take you to the definition in the schema file. If you press F1 or hover over a symbol, you can see the quick documentation for that symbol.

Completion for GraphQl in JavaScript

Find usages and the Rename refactoring will also work as you would expect them to.

Describing the environment

For the information about your development environment, the JS GraphQL plugin relies on the .graphqlconfig file. In this file you can specify the GraphQL endpoints, the location of the schema file, as well as the files included and excluded from the scope of the schema.

If you have a more complex project with multiple schemas, you can create separate .graphqlconfig files (New… – GraphQL Configuration File) in each part of your app to configure them.

The GraphQL tool window displays information about your schemas and endpoints based on these configuration files. It will also show any errors after running a query against the endpoint.

qraphqlconfig and tool window

Configuration recipes

In the graphql-config-examples repository, you can find recipes describing how to use the .graphqlconfig files to set up different types of projects that use GraphQL, including an Apollo full-stack app and a Relay app.

Doing introspection

Once you’ve specified the endpoints for your GraphQL server in the configuration file, you can now run introspection – it will ask the server to generate the schema and provide information about what queries it supports. The result of introspection will be saved in the file specified in the schemaPath file in .graphqlconfig.

To run introspection, double-click the endpoint in the GraphQL tool window and select Get GraphQL Schema from Endpoint (introspection).

Run introspection

Running queries

If you want to run a query for a specific endpoint, you can do it easily. What you need is a file with a .graphql extension (it can be a regular file in your project or a temporary scratch file) in which you can write your query. On top of the file, select the endpoint that you want to use to run your query, and then click the green icon to run it. You’ll see the result in the new Query result tab in the GraphQL tool window.

Run GraphQL query

You can also create a new scratch file for your query from the tool window – double-click on the endpoint and select the corresponding action.

To install the JS GraphQL plugin, go to the IDE’s Preferences/Settings | Plugins – Marketplace and search for JS GraphQL.

The plugin is open source and available on GitHub, where you can also submit any bug reports and feature requests. Your contributions to the plugin and its documentation are very welcome!

The WebStorm team

Comments below can no longer be edited.

15 Responses to Featured Plugin: JS GraphQL

  1. Oscar says:

    April 18, 2019

    This plugin is a must to work with Gatsby!

  2. Carlton Dickson says:

    May 23, 2019

    Was using PHP and running the built in web server…

    php -S localhost:

    but kept getting this error when trying to run introspect query…

    GraphQL Query Error
    http://localhost:8084/graphql.php: Connection refused (Connection refused)

    Apparently the localhost command starts server with ipv6 support only. The following worked for me
    php -S
    php -S

    See here for more details – https://www.php.net/manual/en/features.commandline.webserver.php#120449

  3. Cesar Martinez says:

    November 10, 2019

    Anyone knows how to make this work, or how to work with this within a Meteor-Apollo project?

  4. Andrew says:

    March 13, 2020

    This plugin is awesome, the only thing I’m missing is the request history. So it would save previous sets of query variables similar to how it’s done in GraphQL playground. Is there any way to make it work or will it be implemented in future versions?

    • Ekaterina Ryabukha says:

      March 16, 2020

      Hello Andrew,
      This third-party plugin is open source and available on GitHub, where you can submit any bug reports/feature requests as well as contribute to its development. A new feature request can be submitted here: https://github.com/jimkyndemeyer/js-graphql-intellij-plugin/issues. Please let us know if you have any other questions.

  5. sejisok says:

    March 16, 2020

    WebStorm need to add official support for GraphQL that integrates directly with the framework they support, like Angular (Apollo Angular) etc.

  6. Jarek says:

    March 27, 2020

    Does this work with @client directive?

  7. Alexander Gavazov says:

    April 7, 2020

    Very useful, but support for Apollo Federation needs to be optimized because there are extend and duplicate types, mutations, queries …
    It would be great if you add an option of not highlighting at least the errors because the syntax is correct but it is marked as wrong.

  8. ryota says:

    May 16, 2020

    How to show Query result tab after creating .graphql file from different file extension?