Skip to content

Commit

Permalink
docs: mention zed integration (#2637)
Browse files Browse the repository at this point in the history
* docs: mention zed integration

* remove image width
  • Loading branch information
Alex Plischke authored Feb 14, 2024
1 parent ff8abed commit a89f583
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs/dev/cli/saucectl/usage/ide/intellij.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ IntelliJ can help you edit the `saucectl` configuration files by providing helpf

Our JSON schema is published to the [JSON Schema Store](https://www.schemastore.org/json/), which is made available to IntelliJ. To proceed, open your `saucectl` config yaml in IntelliJ and select the `SauceCTL Configuration` schema [per the IDEA instructions](https://www.jetbrains.com/help/idea/json.html#ws_json_using_schemas).

<img src={useBaseUrl('img/stt/intellij-saucectl-schema-dropdown.png')} alt="IntelliJ Schema Dropdown" width="400"/>
<img src={useBaseUrl('img/stt/intellij-saucectl-schema-dropdown.png')} alt="IntelliJ Schema Dropdown" />

You should now be able to see the docs for various attributes:

<img src={useBaseUrl('img/stt/intellij-yaml-docs.png')} alt="IntelliJ YAML Attribute Description" width="300"/>
<img src={useBaseUrl('img/stt/intellij-yaml-docs.png')} alt="IntelliJ YAML Attribute Description" />

and have autocompletion ready at your fingertips!

<img src={useBaseUrl('img/stt/intellij-yaml-autocomplete.png')} alt="IntelliJ YAML Attribute Autocompletion" width="500"/>
<img src={useBaseUrl('img/stt/intellij-yaml-autocomplete.png')} alt="IntelliJ YAML Attribute Autocompletion" />

:::caution Known Limitations
At the time of writing, IntelliJ's autocompletion has a bug when dealing with complex JSON schemas. While the validation takes place correctly, the suggestion/autocompletion feature may not work as intended. Until this behavior is fully addressed by JetBrains, you may want to check out our [Visual Studio Code Integration](vscode.md) in the meantime.
Expand Down
4 changes: 2 additions & 2 deletions docs/dev/cli/saucectl/usage/ide/vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ checking the Visual Studio Code settings to confirm that `yaml.schemaStore.enabl

If your `saucectl` config YAML is stored in a `.sauce/` folder, Visual Studio Code will automatically apply the schema to all YAML files contained in that folder and no further action is required.

You should now be able to see the docs for various attributes:<br/><img src={useBaseUrl('img/stt/vscode-yaml-docs.png')} alt="Visual Studio Code YAML Attribute Description" width="300"/>
You should now be able to see the docs for various attributes:<br/><img src={useBaseUrl('img/stt/vscode-yaml-docs.png')} alt="Visual Studio Code YAML Attribute Description" />

and have autocompletion ready at your fingertips!<br/><img src={useBaseUrl('img/stt/vscode-yaml-autocomplete.png')} alt="Visual Studio Code YAML Attribute Autocompletion" width="400"/>
and have autocompletion ready at your fingertips!<br/><img src={useBaseUrl('img/stt/vscode-yaml-autocomplete.png')} alt="Visual Studio Code YAML Attribute Autocompletion" />

Alternatively, it's also possible to associate schema files with files they are supposed to validate by adding the mapping into your Visual Studio Code settings:

Expand Down
25 changes: 25 additions & 0 deletions docs/dev/cli/saucectl/usage/ide/zed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
id: zed
title: saucectl with Zed
sidebar_label: Zed
---

import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Zed can help you edit the `saucectl` configuration files by providing helpful suggestions, autocompletion and docs; all without having to leave the IDE.

## What You'll Need

- [Zed](https://zed.dev/)

## JSON Schema Validation

Our JSON schema is published to the [JSON Schema Store](https://www.schemastore.org/json/), which is made available to Zed.

If your `saucectl` config YAML is stored in a `.sauce/` folder, Zed will automatically apply the schema to all YAML files contained in that folder and no further action is required.

You should now be able to see the docs for various attributes:<br/><img src={useBaseUrl('img/stt/zed-yaml-docs.png')} alt="Zed YAML Attribute Description" />

and have autocompletion ready at your fingertips!<br/><img src={useBaseUrl('img/stt/zed-yaml-autocomplete.png')} alt="Zed YAML Attribute Autocompletion" />
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -777,6 +777,7 @@ module.exports = {
items: [
'dev/cli/saucectl/usage/ide/intellij',
'dev/cli/saucectl/usage/ide/vscode',
'dev/cli/saucectl/usage/ide/zed',
],
},
],
Expand Down
Binary file added static/img/stt/zed-yaml-autocomplete.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/stt/zed-yaml-docs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a89f583

Please sign in to comment.