Neovim

Prerequisites

1. Install the LSP server binary (see Installation)
2. Install nvim-lspconfig

Setup with nvim-lspconfig

Add to your init.lua:

require('lspconfig').graphql.setup {
  cmd = { 'graphql-lsp' },
  filetypes = { 'graphql', 'typescript', 'typescriptreact', 'javascript', 'javascriptreact', 'vue', 'svelte', 'astro' },
  root_dir = require('lspconfig.util').root_pattern(
    '.graphqlrc*',
    'graphql.config.*'
  ),
}

Note

Note: Nvim 0.11+ users should prefer the new-style vim.lsp.config API. The built-in graphql server in nvim-lspconfig points to a different tool — always pass an explicit cmd = { 'graphql-lsp' } to use this project’s LSP server.

Custom binary path

If the LSP server isn’t on your $PATH:

require('lspconfig').graphql.setup {
  cmd = { '/path/to/graphql-lsp' },
}

Configuration

Create a .graphqlrc.yml in your project root:

schema: schema.graphql
documents: src/**/*.{graphql,ts,tsx}

Debugging

Check LSP logs:

:LspLog

Enable debug logging:

require('lspconfig').graphql.setup {
  cmd = { 'graphql-lsp' },
  cmd_env = {
    RUST_LOG = 'debug',
  },
}