Skip to content

Commit 985cbb5

Browse files
committed
Added IDE plugin docs
1 parent 9c50ec0 commit 985cbb5

File tree

5 files changed

+44
-2
lines changed

5 files changed

+44
-2
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,12 @@ Check out our [getting started guide](https://kotlin.github.io/kotlinx-rpc) for
101101

102102
## Configure the project
103103

104-
### Plugin dependencies
104+
### IDE Plugin
105+
106+
Install [Kotlin External FIR Support](https://plugins.jetbrains.com/plugin/26480-kotlin-external-fir-support?noRedirect=true) IDE plugin.
107+
It will ensure that all IDE features of our compiler plugin work properly.
108+
109+
### Gradle plugins
105110

106111
`kotlinx.rpc` provides Gradle plugin `org.jetbrains.kotlinx.rpc.plugin`
107112
that will set up code generation in a project.

docs/pages/kotlinx-rpc/rpc.tree

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
start-page="get-started.topic">
1212

1313
<toc-element topic="get-started.topic"/>
14+
<toc-element topic="ide-plugin.topic"/>
1415
<toc-element topic="plugins.topic"/>
1516
<toc-element toc-title="Core concepts">
1617
<toc-element topic="services.topic"/>

docs/pages/kotlinx-rpc/topics/get-started.topic

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,16 @@
4141
including but not limited to <a href="https://grpc.io">gRPC</a>.
4242
</p>
4343
</chapter>
44+
<chapter title="IDE Plugin" id="install-ide-plugin">
45+
<p>
46+
Library uses a Kotlin compiler plugin to generate declarations.
47+
To make this work in Intellij-based IDEs,
48+
we provide <a href="https://plugins.jetbrains.com/plugin/26480-kotlin-external-fir-support?noRedirect=true">Kotlin External FIR Support</a> plugin.
49+
</p>
50+
<p>
51+
To learn more, see <a href="ide-plugin.topic"/> page
52+
</p>
53+
</chapter>
4454
<chapter title="Installation" id="installation">
4555
<p>Before adding <code>kotlinx.rpc</code> dependencies, you need to configure your project with <a
4656
href="https://docs.gradle.org/current/userguide/userguide.html">Gradle</a>.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic
3+
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
4+
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5+
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
6+
title="IDE Plugin" id="ide-plugin">
7+
8+
<p>
9+
Library uses a Kotlin compiler plugin to generate declarations.
10+
To make this work in Intellij-based IDEs,
11+
we provide <a href="https://plugins.jetbrains.com/plugin/26480-kotlin-external-fir-support?noRedirect=true">Kotlin External FIR Support</a> plugin.
12+
</p>
13+
<p>
14+
No additional steps to configure the plugin are required.
15+
</p>
16+
<p>
17+
If you encounter other unexpected limitations or bugs,
18+
please <a href="https://github.com/Mr3zee/kotlin-plugins/issues">report</a> them
19+
</p>
20+
<note>
21+
Please note, that the plugin is based on <b>experimental</b> IDE functionality,
22+
which means that only newer IDE versions are supported.
23+
For full compatibility guides, see the plugin page on the
24+
<a href="https://plugins.jetbrains.com/plugin/26480-kotlin-external-fir-support?noRedirect=true">Marketplace</a>.
25+
</note>
26+
</topic>

docs/pages/kotlinx-rpc/topics/plugins.topic

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
88
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
99
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
10-
title="Plugins" id="plugins">
10+
title="Gradle plugin" id="plugins">
1111
<p>
1212
The <code>kotlinx.rpc</code> library offers a <a href="https://docs.gradle.org/current/userguide/plugins.html">Gradle plugin</a>
1313
that simplifies project configuration by automating repetitive tasks: `org.jetbrains.kotlinx.rpc.plugin`

0 commit comments

Comments
 (0)