File tree Expand file tree Collapse file tree 5 files changed +44
-2
lines changed Expand file tree Collapse file tree 5 files changed +44
-2
lines changed Original file line number Diff line number Diff line change @@ -101,7 +101,12 @@ Check out our [getting started guide](https://kotlin.github.io/kotlinx-rpc) for
101
101
102
102
## Configure the project
103
103
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
105
110
106
111
` kotlinx.rpc ` provides Gradle plugin ` org.jetbrains.kotlinx.rpc.plugin `
107
112
that will set up code generation in a project.
Original file line number Diff line number Diff line change 11
11
start-page =" get-started.topic" >
12
12
13
13
<toc-element topic =" get-started.topic" />
14
+ <toc-element topic =" ide-plugin.topic" />
14
15
<toc-element topic =" plugins.topic" />
15
16
<toc-element toc-title =" Core concepts" >
16
17
<toc-element topic =" services.topic" />
Original file line number Diff line number Diff line change 41
41
including but not limited to <a href =" https://grpc.io" >gRPC</a >.
42
42
</p >
43
43
</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 >
44
54
<chapter title =" Installation" id =" installation" >
45
55
<p >Before adding <code >kotlinx.rpc</code > dependencies, you need to configure your project with <a
46
56
href =" https://docs.gradle.org/current/userguide/userguide.html" >Gradle</a >.
Original file line number Diff line number Diff line change
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 >
Original file line number Diff line number Diff line change 7
7
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
8
8
<topic xmlns : xsi =" http://www.w3.org/2001/XMLSchema-instance"
9
9
xsi : noNamespaceSchemaLocation =" https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
10
- title =" Plugins " id =" plugins" >
10
+ title =" Gradle plugin " id =" plugins" >
11
11
<p >
12
12
The <code >kotlinx.rpc</code > library offers a <a href =" https://docs.gradle.org/current/userguide/plugins.html" >Gradle plugin</a >
13
13
that simplifies project configuration by automating repetitive tasks: `org.jetbrains.kotlinx.rpc.plugin`
You can’t perform that action at this time.
0 commit comments