Hasura Language Server Extension for VS Code

This VSCode extension offers robust language server support for Hasura DDN, enriching your development workflow with features such as autocompletion, auto-scaffolding, syntax highlighting, and more.

Currently in development, we welcome your feedback! Please submit any feature requests or bug reports to the Hasura graphql-engine repository.

Features

• Autocompletion: Receive smart suggestions for Hasura keywords, functions, and more as you type.
• Syntax Highlighting: Enhance code readability with color-coded syntax for Hasura.
• Validation: Detect errors in real-time with automatic error checking and validation.
• Hover Documentation: Access documentation links for all metadata objects directly by hovering over them.
• Rename Operation: Seamlessly rename any metadata object, with all references automatically updated for you ✨.

Getting Started

Using local VS Code:

1. Install VS Code for your operating system.
2. Install the hasura extension from the extensions page.
3. Open a local Hasura project that contains a hasura.yaml in VS Code. This will activate the extension.

Using vscode.dev:

Follow the following steps to use the extension on browser without installing VS Code locally.

1. Use chrome or edge browser.
2. Visit vscode.dev
3. Install the hasura extension from the extensions page.
4. Open any local folder and experience the hasura extension in your browser!

Note: Full feature support for browser-based VS Code is currently available only on vscode.dev. For github.dev, only basic structural support is provided. github.dev allows Hasura DDN projects hosted on GitHub to use the extension directly from the browser. If you'd like to see enhanced support for github.dev, please upvote or comment on this GitHub issue.

Usage

Autocompletion

Quickly and easily scaffold out portions of your metadata with autocompletion. As you type, the extension will provide suggestions for Hasura keywords and functions. You can use ctrl+space to trigger autocompletion manually and select from the available options.

Validation

Catch errors early with real-time error checking and validation. The extension will highlight any warnings or errors in your metadata files as you type. Hover over the error to see more details and suggestions for how to fix it. This ensures that your metadata is always in a valid state before creating or testing a new build.

Go to Definition

Quickly navigate to the definition of any metadata object by right-clicking on the object and selecting "Go to Definition" from the context menu. This will take you directly to the location where the object is defined in your metadata files.

Hover Documentation

Get direct links to documentation for all metadata objects by hovering over the object in your metadata files. This will display a tooltip with a link to the relevant section of the Hasura documentation, allowing you to quickly access more information about the object.

Rename Operation

Rename any metadata object and all its references will be auto-magically✨ updated. Right-click on the object you want to rename and select "Rename Symbol" from the context menu. Enter the new name and press enter to update all references to the object in your metadata files.