hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 10:17:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

bundling_plugin_openapi_sources.md: rework trees using PlantUML, minor edits

Browse Source
This commit is contained in:
Yann Cébron 2024-01-31 13:14:26 +01:00
parent fc64cba441
commit 5c8521245f
1 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
topics/basics/bundling_plugin_openapi_sources.md
View File

@ -1,7 +1,7 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# Bundling Plugin API Sources
<!-- Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Exposing plugin's API sources for other plugins.</link-summary>
If a plugin exposes its own API that is meant to be used by other plugins, it is worth considering bundling the plugin's API sources in the ZIP distribution.
@ -17,16 +17,26 @@ Being able to see API sources drastically improves the development experience, a
The API source JARs must be located in the <path>example-plugin.zip!/plugin/lib/src</path> directory in the plugin ZIP distribution, e.g.:
```text
example-plugin.zip
└── example-plugin
└── lib
├── example-plugin.jar
└── src
└── example-plugin-api-src.jar
```plantuml
@startuml
skinparam TitleFontName JetBrains Sans
skinparam TitleFontStyle plain
skinparam TitleFontSize 16
skinparam DefaultTextAlignment left
title
example-plugin.zip // (Plugin distribution file) //
|_ example-plugin
|_ lib
|_ example-plugin.jar // (Plugin) //
|_ src
|_ example-plugin-api-src.jar // (API sources JAR) //
end title
@enduml
```
The plugin ZIP can contain multiple source JARs, and there are no strict rules for the source JAR names.
The plugin distribution ZIP file can contain multiple source JARs, and there are no strict rules for the source JAR names.
## Defining Plugin API