diff --git a/README.md b/README.md index e3987ff93..c574003cc 100644 --- a/README.md +++ b/README.md @@ -101,7 +101,12 @@ Check out our [getting started guide](https://kotlin.github.io/kotlinx-rpc) for ## Configure the project -### Plugin dependencies +### Plugin for IntelliJ-based IDEs + +To ensure that all IDE features of our compiler plugin work properly on IntelliJ-based IDEs, install the +[Kotlin External FIR Support](https://plugins.jetbrains.com/plugin/26480-kotlin-external-fir-support?noRedirect=true) plugin. + +### Gradle plugins `kotlinx.rpc` provides Gradle plugin `org.jetbrains.kotlinx.rpc.plugin` that will set up code generation in a project. diff --git a/docs/pages/kotlinx-rpc/rpc.tree b/docs/pages/kotlinx-rpc/rpc.tree index e671d020f..aef7ccde8 100644 --- a/docs/pages/kotlinx-rpc/rpc.tree +++ b/docs/pages/kotlinx-rpc/rpc.tree @@ -11,6 +11,7 @@ start-page="get-started.topic"> + diff --git a/docs/pages/kotlinx-rpc/topics/get-started.topic b/docs/pages/kotlinx-rpc/topics/get-started.topic index 6ba7fe8f1..72e616d67 100644 --- a/docs/pages/kotlinx-rpc/topics/get-started.topic +++ b/docs/pages/kotlinx-rpc/topics/get-started.topic @@ -41,6 +41,16 @@ including but not limited to gRPC.

+ +

+ Library uses a Kotlin compiler plugin to generate declarations. + To make this work in Intellij-based IDEs, + we provide Kotlin External FIR Support plugin. +

+

+ To learn more, see page +

+

Before adding kotlinx.rpc dependencies, you need to configure your project with Gradle. diff --git a/docs/pages/kotlinx-rpc/topics/ide-plugin.topic b/docs/pages/kotlinx-rpc/topics/ide-plugin.topic new file mode 100644 index 000000000..10eea4727 --- /dev/null +++ b/docs/pages/kotlinx-rpc/topics/ide-plugin.topic @@ -0,0 +1,46 @@ + + + + +

+ The kotlinx.rpc library uses an external Kotlin compiler plugin to generate declarations. + To ensure compatibility with IntelliJ-based IDEs, we provide the + + Kotlin External FIR Support + + plugin. +

+ +

+ The plugin is based on experimental IDE functionality, + which means that only newer IDE versions are supported. + For full compatibility guidelines, refer to the + + the plugin documentation on the JetBrains Marketplace + + . +

+
+ +

+ No additional configuration is required. The plugin works automatically upon installation. +

+
+ +

+ There are currently no known limitations when using the plugin on supported IDE versions. +

+

+ If you encounter issues, unexpected limitations, or bugs, + please report them by creating a new issue on + + GitHub + + . +

+
+ + diff --git a/docs/pages/kotlinx-rpc/topics/plugins.topic b/docs/pages/kotlinx-rpc/topics/plugins.topic index 7e1620329..2c0db9c33 100644 --- a/docs/pages/kotlinx-rpc/topics/plugins.topic +++ b/docs/pages/kotlinx-rpc/topics/plugins.topic @@ -7,7 +7,7 @@ SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd"> + title="Gradle plugin" id="plugins">

The kotlinx.rpc library offers a Gradle plugin that simplifies project configuration by automating repetitive tasks: `org.jetbrains.kotlinx.rpc.plugin`