Skip to content

Commit

Permalink
Add doc for IntelliJ (#22)
Browse files Browse the repository at this point in the history
  • Loading branch information
kinow authored Dec 6, 2023
1 parent 7bbbe5e commit 91fe99e
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 0 deletions.
3 changes: 3 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,9 @@ pipx install -e denbi-benten # denbi-benten is the name of the directory with t

See [this page](https://github.com/denbi/denbi-benten/blob/main/docs/vim.md) please.

# Using with IntelliJ

See [this page](https://github.com/rabix/benten/blob/master/docs/intellij.md) please.

# Expression evaluations on hover

Expand Down
28 changes: 28 additions & 0 deletions docs/intellij.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Running Benten with IntelliJ

## Install

1. Install Benten.
2. Find the location of `benten-ls` (you will need that later.)
3. Install the **LSP Support** plug-in: <https://plugins.jetbrains.com/plugin/10209-lsp-support>
4. Open the IntelliJ Settings, and navigate to [ Languages & Frameworks > Language Server Protocol > Server Definitions ].
5. Add an LSP entry as per screenshot below, entering the location of `benten-ls` found in step 2.

![](../media/2021.11.13/lsp-definition-intellij.png)

6. Finally, now navigate to [ Editor > TextMate Bundles ], click on the `+` (plus) sign, and select the directory of the `vscode-client` of Benten. You should see a new entry after you confirm your settings.

![](../media/2021.11.13/lsp-editor.png)

That's it, now you should be ready to open a CWL file with syntax highlighting and auto-complete.

![](../media/2021.11.13/lsp-intellij.png)

>NOTE: Language Server Protocol is not natively supported in IntelliJ,
>so the installation notes here may need to be updated if the LSP Plug-in changes
>or if IntelliJ changes its API.
## References:

- Robot Framework, “PyCharm with LSP”: https://forum.robotframework.org/t/pycharm-with-lsp/161

Binary file added media/2021.11.13/lsp-definition-intellij.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 media/2021.11.13/lsp-editor.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 media/2021.11.13/lsp-intellij.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 91fe99e

Please sign in to comment.