diff --git a/Readme.md b/Readme.md index 963d415..cbecf1a 100644 --- a/Readme.md +++ b/Readme.md @@ -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 diff --git a/docs/intellij.md b/docs/intellij.md new file mode 100644 index 0000000..cbff1df --- /dev/null +++ b/docs/intellij.md @@ -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: +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 + diff --git a/media/2021.11.13/lsp-definition-intellij.png b/media/2021.11.13/lsp-definition-intellij.png new file mode 100644 index 0000000..83de39c Binary files /dev/null and b/media/2021.11.13/lsp-definition-intellij.png differ diff --git a/media/2021.11.13/lsp-editor.png b/media/2021.11.13/lsp-editor.png new file mode 100644 index 0000000..8bc7c33 Binary files /dev/null and b/media/2021.11.13/lsp-editor.png differ diff --git a/media/2021.11.13/lsp-intellij.png b/media/2021.11.13/lsp-intellij.png new file mode 100644 index 0000000..968e380 Binary files /dev/null and b/media/2021.11.13/lsp-intellij.png differ