Skip to content

Commit 43f864c

Browse files
Add documentation
1 parent 656d433 commit 43f864c

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/source/commands/supergraphs.mdx

+20
Original file line numberDiff line numberDiff line change
@@ -229,3 +229,23 @@ We recommend updating to the latest version of Rover as soon as possible. If you
229229
|---|---|
230230
|<= v0.2.x|<= v0.38.x|
231231
|>= v0.3.x|>= v0.39.x|
232+
233+
## Configuration awareness in your text editor
234+
235+
### `supergraph print-json-schema`
236+
237+
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.
238+
239+
Generate the schema with the following command:
240+
241+
```bash
242+
rover supergraph print-json-schema
243+
```
244+
245+
After you generate the schema, configure your text editor. Here are the instructions for some commonly used editors:
246+
247+
- [Visual Studio Code](https://code.visualstudio.com/docs/languages/json#_json-schemas-and-settings)
248+
- [Emacs](https://emacs-lsp.github.io/lsp-mode/page/lsp-yaml)
249+
- [IntelliJ](https://www.jetbrains.com/help/idea/json.html#ws_json_using_schemas)
250+
- [Sublime](https://github.com/sublimelsp/LSP-yaml)
251+
- [Vim](https://github.com/Quramy/vison)

0 commit comments

Comments
 (0)