Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.57 KB

intellij.md

File metadata and controls

33 lines (21 loc) · 1.57 KB
id title sidebar_label
intellij
saucectl with IntelliJ
IntelliJ IDEA

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

IntelliJ 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

JSON Schema Validation

Our JSON schema is published to the JSON Schema Store, 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.

<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" />

and have autocompletion ready at your fingertips!

<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 in the meantime. :::