docs: Getting started documentation #33

angelozerr · 2023-12-07T08:59:22Z

docs: Getting started documentation

Fixes #24

docs/DeveloperGuide.md

docs/LSPSupport.md

Fixes redhat-developer#24 Signed-off-by: azerr <[email protected]>

fbricon

Still need to check LSPSupport.md

fbricon · 2023-12-15T14:15:35Z

docs/DeveloperGuide.md

+
+### Exclude all LSP4J dependencies
+
+LSP4IJ depends on [Eclipse LSP4J](https://github.com/eclipse-lsp4j/lsp4j) (Java binding for the [Language Server Protocol](https://microsoft.github.io/language-server-protocol) and the [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol).). It uses a given version of LSPJ and their classes are loaded in the LSP4IJ plugin class loader.


It provides its own version of LSP4J and its classes are loaded in the LSP4IJ plugin class loader.

fbricon · 2023-12-15T14:20:38Z

docs/DeveloperGuide.md

+
+LSP4IJ depends on [Eclipse LSP4J](https://github.com/eclipse-lsp4j/lsp4j) (Java binding for the [Language Server Protocol](https://microsoft.github.io/language-server-protocol) and the [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol).). It uses a given version of LSPJ and their classes are loaded in the LSP4IJ plugin class loader.
+
+Your IntelliJ Plugin should use `the same LSP4J classes than LSP4IJ` to avoid some `ClassCastException` errors. To do that you need to `exclude all LSP4J dependencies` from your plugin.


Your IntelliJ Plugin must not embed its own version of LSP4J, in order to avoid conflicts with the version provided by LSP4IJ. Failing to do see will result in ClassCastException errors to be thrown. Make sure that the LSP4J dependency in your plugin is either declared with a "runtimeOnly" scope or excluded entirely if it's included as a transitive dependency.

fbricon · 2023-12-15T14:22:42Z

docs/DeveloperGuide.md

+
+Your IntelliJ Plugin should use `the same LSP4J classes than LSP4IJ` to avoid some `ClassCastException` errors. To do that you need to `exclude all LSP4J dependencies` from your plugin.
+
+Here a sample used in [Quarkus Tools](https://github.com/redhat-developer/intellij-quarkus) in [build.gradle.kts](https://github.com/redhat-developer/intellij-quarkus/blob/main/build.gradle.kts) to exclude LSP4J dependency from the [Qute Language Server](https://github.com/redhat-developer/quarkus-ls/tree/master/qute.ls) which have a dependency to LSP4J:


to exclude the LSP4J dependency from the Qute Language Server.

fbricon · 2023-12-15T14:24:02Z

docs/DeveloperGuide.md

+## LanguageServerFactory
+
+Create an implementation of [LanguageServerFactory](https://github.com/redhat-developer/lsp4ij/blob/main/src/main/java/com/redhat/devtools/lsp4ij/LanguageServerFactory.java) to use your `my.language.server.MyLanguageServer`, `my.language.server.MyLanguageClient` and defines a custom LanguageServer API if you need:
+
+```java
+package my.language.server;
+
+import com.intellij.openapi.project.Project;
+import com.redhat.devtools.lsp4ij.LanguageServerFactory;
+import com.redhat.devtools.lsp4ij.client.LanguageClientImpl;
+import com.redhat.devtools.lsp4ij.server.StreamConnectionProvider;
+import org.jetbrains.annotations.NotNull;
+
+public class MyLanguageServerFactory implements LanguageServerFactory {
+
+    @Override
+    public @NotNull StreamConnectionProvider createConnectionProvider(@NotNull Project project) {
+        return new MyLanguageServer(project);
+    }
+
+    @Override
+    public @NotNull LanguageClientImpl createLanguageClient(@NotNull Project project) {
+        return new MyLanguageClient(project);
+    }
+}
+```


move below L37

fbricon · 2023-12-15T14:25:28Z

docs/DeveloperGuide.md

+
+## Add specific IJ features
+
+When it is possible, LSP4IJ declare the IJ feature with `any` language.


LSP4IJ binds IJ features to any language.

fbricon · 2023-12-15T14:26:17Z

docs/DeveloperGuide.md

+<codeInsight.inlayProvider
+  language="MyLanguage" 
+  implementationClass="com.redhat.devtools.lsp4ij.operations.codelens.LSPCodelensInlayProvider"/>
+```
+
+ * `textDocument/inlayHint`:
+
+```xml 
+<codeInsight.inlayProvider
+  language="MyLanguage" 
+  implementationClass="com.redhat.devtools.lsp4ij.operations.codelens.LSPInlayHintInlayProvider"/>
+```


this should not be necessary anymore right?

fbricon · 2023-12-15T14:26:47Z

docs/UserGuide.md

+
+![LSP console](./images/LSPConsole.png)
+
+When language server is started, several action like stopping the language server or copy the command which starts the language servers are available:


several actions

Signed-off-by: Fred Bricon <[email protected]>

angelozerr · 2023-12-15T18:04:28Z

Thanks so much @fbricon for your great review!

openshift-ci bot added the do-not-merge/work-in-progress label Dec 7, 2023

angelozerr added the documentation Improvements or additions to documentation label Dec 7, 2023

angelozerr force-pushed the getting_started branch from cb11dff to 4b53999 Compare December 7, 2023 09:05

angelozerr self-assigned this Dec 7, 2023

angelozerr added this to the 0.0.1 milestone Dec 7, 2023

angelozerr force-pushed the getting_started branch 6 times, most recently from 0cf9ae8 to 63bafcb Compare December 9, 2023 16:45

angelozerr changed the title ~~doc: Getting started documentation~~ docs: Getting started documentation Dec 9, 2023

angelozerr force-pushed the getting_started branch 6 times, most recently from 1777a46 to 4b04b53 Compare December 11, 2023 09:40

angelozerr marked this pull request as ready for review December 11, 2023 09:41

openshift-ci bot removed the do-not-merge/work-in-progress label Dec 11, 2023

angelozerr requested a review from fbricon December 11, 2023 09:41

angelozerr force-pushed the getting_started branch 2 times, most recently from 3ff3148 to 91cb6e4 Compare December 11, 2023 14:06

angelozerr marked this pull request as draft December 11, 2023 14:16

openshift-ci bot added the do-not-merge/work-in-progress label Dec 11, 2023

angelozerr force-pushed the getting_started branch 5 times, most recently from 1b91f64 to 92bc62b Compare December 11, 2023 16:58

angelozerr force-pushed the getting_started branch 2 times, most recently from 3b64430 to 3e50b1d Compare December 11, 2023 17:15

angelozerr marked this pull request as ready for review December 11, 2023 17:15

openshift-ci bot removed the do-not-merge/work-in-progress label Dec 11, 2023

angelozerr force-pushed the getting_started branch from 3e50b1d to 5c5968b Compare December 12, 2023 09:01

fbricon requested changes Dec 12, 2023

View reviewed changes

angelozerr force-pushed the getting_started branch 8 times, most recently from 45fab1b to 98385ef Compare December 14, 2023 13:29

docs: Getting started documentation

3d10917

Fixes redhat-developer#24 Signed-off-by: azerr <[email protected]>

angelozerr force-pushed the getting_started branch from 98385ef to 3d10917 Compare December 15, 2023 13:26

fbricon requested changes Dec 15, 2023

View reviewed changes

fbricon force-pushed the getting_started branch from 224d685 to 8a37c68 Compare December 15, 2023 15:28

doc: rework docs/LSPSupport.md

35570ea

Signed-off-by: Fred Bricon <[email protected]>

fbricon force-pushed the getting_started branch 2 times, most recently from 2f2b43c to ab5e0f2 Compare December 15, 2023 16:45

doc: corrections in docs/UserGuide.md and docs/DeveloperGuide.md

5018db4

Signed-off-by: Fred Bricon <[email protected]>

fbricon force-pushed the getting_started branch from ab5e0f2 to 5018db4 Compare December 15, 2023 16:51

angelozerr merged commit c114384 into redhat-developer:main Dec 15, 2023
6 checks passed

angelozerr mentioned this pull request May 13, 2024

Freeze when IJ starts #289

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Getting started documentation #33

docs: Getting started documentation #33

angelozerr commented Dec 7, 2023 •

edited

Loading

fbricon left a comment

fbricon Dec 15, 2023

fbricon Dec 15, 2023

fbricon Dec 15, 2023

fbricon Dec 15, 2023

fbricon Dec 15, 2023

fbricon Dec 15, 2023

fbricon Dec 15, 2023

angelozerr commented Dec 15, 2023


		### Exclude all LSP4J dependencies

		LSP4IJ depends on [Eclipse LSP4J](https://github.com/eclipse-lsp4j/lsp4j) (Java binding for the [Language Server Protocol](https://microsoft.github.io/language-server-protocol) and the [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol).). It uses a given version of LSPJ and their classes are loaded in the LSP4IJ plugin class loader.


		LSP4IJ depends on [Eclipse LSP4J](https://github.com/eclipse-lsp4j/lsp4j) (Java binding for the [Language Server Protocol](https://microsoft.github.io/language-server-protocol) and the [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol).). It uses a given version of LSPJ and their classes are loaded in the LSP4IJ plugin class loader.

		Your IntelliJ Plugin should use `the same LSP4J classes than LSP4IJ` to avoid some `ClassCastException` errors. To do that you need to `exclude all LSP4J dependencies` from your plugin.


		Your IntelliJ Plugin should use `the same LSP4J classes than LSP4IJ` to avoid some `ClassCastException` errors. To do that you need to `exclude all LSP4J dependencies` from your plugin.

		Here a sample used in [Quarkus Tools](https://github.com/redhat-developer/intellij-quarkus) in [build.gradle.kts](https://github.com/redhat-developer/intellij-quarkus/blob/main/build.gradle.kts) to exclude LSP4J dependency from the [Qute Language Server](https://github.com/redhat-developer/quarkus-ls/tree/master/qute.ls) which have a dependency to LSP4J:


		## Add specific IJ features

		When it is possible, LSP4IJ declare the IJ feature with `any` language.


		![LSP console](./images/LSPConsole.png)

		When language server is started, several action like stopping the language server or copy the command which starts the language servers are available:

docs: Getting started documentation #33

docs: Getting started documentation #33

Conversation

angelozerr commented Dec 7, 2023 • edited Loading

fbricon left a comment

Choose a reason for hiding this comment

fbricon Dec 15, 2023

Choose a reason for hiding this comment

fbricon Dec 15, 2023

Choose a reason for hiding this comment

fbricon Dec 15, 2023

Choose a reason for hiding this comment

fbricon Dec 15, 2023

Choose a reason for hiding this comment

fbricon Dec 15, 2023

Choose a reason for hiding this comment

fbricon Dec 15, 2023

Choose a reason for hiding this comment

fbricon Dec 15, 2023

Choose a reason for hiding this comment

angelozerr commented Dec 15, 2023

angelozerr commented Dec 7, 2023 •

edited

Loading