Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathanrainer committed Feb 23, 2025
1 parent 656d433 commit 43f864c
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/source/commands/supergraphs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -229,3 +229,23 @@ We recommend updating to the latest version of Rover as soon as possible. If you
|---|---|
|<= v0.2.x|<= v0.38.x|
|>= v0.3.x|>= v0.39.x|

## Configuration awareness in your text editor

### `supergraph print-json-schema`

You can use Rover to generate a JSON schema for config validation in your text editor. This schema helps you format the YAML file correctly and also provides content assist.

Generate the schema with the following command:

```bash
rover supergraph print-json-schema
```

After you generate the schema, configure your text editor. Here are the instructions for some commonly used editors:

- [Visual Studio Code](https://code.visualstudio.com/docs/languages/json#_json-schemas-and-settings)
- [Emacs](https://emacs-lsp.github.io/lsp-mode/page/lsp-yaml)
- [IntelliJ](https://www.jetbrains.com/help/idea/json.html#ws_json_using_schemas)
- [Sublime](https://github.com/sublimelsp/LSP-yaml)
- [Vim](https://github.com/Quramy/vison)

0 comments on commit 43f864c

Please # to comment.