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

creating_plugin_project.md: rework trees using PlantUML, minor edits

Browse Source
This commit is contained in:
Yann Cébron 2024-01-31 13:26:57 +01:00
parent 342192f48a
commit a76a87d456
1 changed files with 32 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
topics/tutorials/build_system/creating_plugin_project.md
View File

@ -46,27 +46,37 @@ Launch the <control>New Project</control> wizard via the <ui-path>File | New | P
For the example `my_plugin` created with the steps describes above, the _IDE Plugin_ generator creates the following directory content: For the example `my_plugin` created with the steps describes above, the _IDE Plugin_ generator creates the following directory content:
```text ```plantuml
my_plugin @startuml
├── .run
│ └── Run IDE with Plugin.run.xml skinparam TitleFontName JetBrains Sans
├── gradle skinparam TitleFontStyle plain
│ └── wrapper skinparam TitleFontSize 16
│ ├── gradle-wrapper.jar skinparam DefaultTextAlignment left
│ └── gradle-wrapper.properties
├── src title
│ └── main my_plugin
│ ├── kotlin |_ .run
│ └── resources |_ Run IDE with Plugin.run.xml
│ └── META-INF |_ gradle
│ ├── plugin.xml |_ wrapper
│ └── pluginIcon.svg |_ gradle-wrapper.jar
├── .gitignore |_ gradle-wrapper.properties
├── build.gradle.kts |_ src
├── gradle.properties |_ main
├── gradlew |_ kotlin
├── gradlew.bat |_ resources
└── settings.gradle.kts |_ META-INF
|_ plugin.xml
|_ pluginIcon.svg
|_ .gitignore
|_ build.gradle.kts
|_ gradle.properties
|_ gradlew
|_ gradlew.bat
|_ settings.gradle.kts
end title
@enduml
``` ```
* The default IntelliJ Platform <path>build.gradle.kts</path> file (see next paragraph). * The default IntelliJ Platform <path>build.gradle.kts</path> file (see next paragraph).
@ -74,7 +84,7 @@ my_plugin
* The <path>settings.gradle.kts</path> file, containing a definition of the `rootProject.name` and required repositories. * The <path>settings.gradle.kts</path> file, containing a definition of the `rootProject.name` and required repositories.
* The Gradle Wrapper files, and in particular the <path>gradle-wrapper.properties</path> file, which specifies the version of Gradle to be used to build the plugin. * The Gradle Wrapper files, and in particular the <path>gradle-wrapper.properties</path> file, which specifies the version of Gradle to be used to build the plugin.
If needed, the IntelliJ IDEA Gradle plugin downloads the version of Gradle specified in this file. If needed, the IntelliJ IDEA Gradle plugin downloads the version of Gradle specified in this file.
* The <path>META-INF</path> directory under the default `main` [source set](https://docs.gradle.org/current/userguide/java_plugin.html#sec:java_project_layout) contains the plugin [configuration file](plugin_configuration_file.md) and [plugin icon](plugin_icon_file.md). * The <path>META-INF</path> directory under the default `main` [source set](https://docs.gradle.org/current/userguide/java_plugin.html#sec:java_project_layout) contains the plugin [configuration file](plugin_configuration_file.md) and [plugin logo](plugin_icon_file.md).
* The _Run Plugin_ [run configuration](https://www.jetbrains.com/help/idea/run-debug-configuration.html). * The _Run Plugin_ [run configuration](https://www.jetbrains.com/help/idea/run-debug-configuration.html).
The generated `my_plugin` project <path>build.gradle.kts</path> file: The generated `my_plugin` project <path>build.gradle.kts</path> file: