initial commit
This commit is contained in:
hgranthorner
152
README.md
Normal file
152
README.md
Normal file
@@ -0,0 +1,152 @@
|
||||
# Intellijai
|
||||
|
||||
[](https://twitter.com/JBPlatform)
|
||||
[][jb:forum]
|
||||
|
||||
## Overview
|
||||
|
||||
This repository implements an IntelliJ Platform plugin.
|
||||
|
||||
## Demo Functionality
|
||||
|
||||
The sample plugin adds a `My Tool Window` tool window with a simple functionality of shuffling a random number.
|
||||
|
||||
## Plugin structure
|
||||
|
||||
A generated project contains the following content structure:
|
||||
|
||||
```
|
||||
.
|
||||
├── .run/ Predefined Run/Debug Configurations
|
||||
├── gradle
|
||||
│ ├── wrapper/ Gradle Wrapper
|
||||
│ ├── libs.versions.toml Version catalog
|
||||
├── src Plugin sources
|
||||
│ └── main
|
||||
│ ├── kotlin/ Kotlin production sources
|
||||
│ └── resources/ Plugin resources
|
||||
│ ├── META-INF/ Plugin configuration file and logo
|
||||
│ └── messages/ Message bundles
|
||||
├── .gitignore Git ignoring rules
|
||||
├── build.gradle.kts Gradle build configuration
|
||||
├── gradle.properties Gradle configuration properties
|
||||
├── gradlew *nix Gradle Wrapper script
|
||||
├── gradlew.bat Windows Gradle Wrapper script
|
||||
├── README.md This file
|
||||
└── settings.gradle.kts Gradle project settings
|
||||
```
|
||||
|
||||
In addition to the configuration files, the most crucial part is the `src` directory, which contains our implementation
|
||||
and the manifest for our plugin – [plugin.xml][file:plugin.xml].
|
||||
|
||||
> [!NOTE]
|
||||
> To use Java in your plugin, create the `/src/main/java` directory.
|
||||
|
||||
The plugin logo is placed in `src/main/resources/META-INF/pluginIcon.svg`. See [Plugin Logo][docs:logo] for more
|
||||
information and logo requirements.
|
||||
|
||||
## Build script
|
||||
|
||||
The [build.gradle.kts][file:build.gradle.kts] is the core of the project definition. It applies three Gradle plugins:
|
||||
|
||||
| Plugin | Description |
|
||||
|-----------------------------------|----------------------------------------------------------------------------------|
|
||||
| `org.jetbrains.kotlin.jvm` | Adds Kotlin support |
|
||||
| `org.jetbrains.changelog` | Simplifies patching the [CHANGELOG.md][file:CHANGELOG.md] file |
|
||||
| `org.jetbrains.intellij.platform` | The [IntelliJ Platform Gradle Plugin][docs:intellij-platform-gradle-plugin-docs] |
|
||||
|
||||
The `intellijPlatform` dependencies block selects the IDE to compile against:
|
||||
|
||||
```kotlin
|
||||
intellijIdea("2025.3.5")
|
||||
```
|
||||
|
||||
See [Target Versions][docs:target-version] for more information.
|
||||
|
||||
The `intellijPlatform` dependencies block also contains a dependency on the platform testing framework:
|
||||
|
||||
```kotlin
|
||||
testFramework(TestFrameworkType.Platform)
|
||||
```
|
||||
|
||||
See [Testing][docs:testing] for more information
|
||||
|
||||
## Plugin configuration file
|
||||
|
||||
The plugin configuration file is a [plugin.xml][file:plugin.xml] file located in the `src/main/resources/META-INF`
|
||||
directory. It provides general information about the plugin, its dependencies, extensions, and listeners.
|
||||
|
||||
You can read more about this file in the [Plugin Configuration File][docs:plugin.xml] section of our documentation.
|
||||
|
||||
### Plugin ID and name
|
||||
|
||||
Generated plugin ID and name may require adjustment.
|
||||
|
||||
These values are generated based on _Group ID_ and _Artifact ID_ provided in the IDE Plugin wizard. It is recommended to
|
||||
review `<id>` and `<name>` elements in the plugin.xml file, and adjust them if needed.
|
||||
|
||||
Please note that Gradle properties `rootProject.name` and `project.group` don't need to match the `<id>` and `<name>`
|
||||
elements. There is no IntelliJ Platform-related reason they should as they serve different functions.
|
||||
|
||||
## Predefined Run/Debug configurations
|
||||
|
||||
Within the default project structure, there is a `.run` directory provided containing predefined *Run/Debug
|
||||
configurations* that expose corresponding Gradle tasks:
|
||||
|
||||
| Configuration name | Description |
|
||||
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| Run IDE with Plugin | Runs [`:runIde`][docs:intellij-platform-gradle-plugin-runIde] IntelliJ Platform Gradle Plugin task. Use the *Debug* icon for plugin debugging. |
|
||||
| Run Tests | Runs [`:check`][gradle:lifecycle-tasks] Gradle task. |
|
||||
| Run Verifications | Runs [`:verifyPlugin`][docs:intellij-platform-gradle-plugin-verifyPlugin] IntelliJ Platform Gradle Plugin task to check the plugin compatibility against the specified IntelliJ IDEs. |
|
||||
|
||||
> [!NOTE]
|
||||
> You can find the logs from the running task in the `idea.log` tab.
|
||||
|
||||
## Publishing the plugin
|
||||
|
||||
> [!TIP]
|
||||
> Make sure to follow all guidelines listed in [Publishing a Plugin][docs:publishing] to follow all recommended and
|
||||
required steps.
|
||||
|
||||
Releasing a plugin to [JetBrains Marketplace](https://plugins.jetbrains.com) is a straightforward operation that uses
|
||||
the `publishPlugin` Gradle task provided by
|
||||
the [intellij-platform-gradle-plugin][docs:intellij-platform-gradle-plugin-docs].
|
||||
|
||||
You can also upload the plugin to the [JetBrains Plugin Repository](https://plugins.jetbrains.com/plugin/upload)
|
||||
manually via UI.
|
||||
|
||||
## Useful links
|
||||
|
||||
- [IntelliJ Platform SDK Plugin SDK][docs]
|
||||
- [IntelliJ Platform Gradle Plugin Documentation][docs:intellij-platform-gradle-plugin-docs]
|
||||
- [IntelliJ Platform Explorer][jb:ipe]
|
||||
- [JetBrains Marketplace Quality Guidelines][jb:quality-guidelines]
|
||||
- [IntelliJ Platform UI Guidelines][jb:ui-guidelines]
|
||||
- [JetBrains Marketplace Paid Plugins][jb:paid-plugins]
|
||||
- [IntelliJ SDK Code Samples][gh:code-samples]
|
||||
|
||||
[docs]: https://plugins.jetbrains.com/docs/intellij
|
||||
[docs:plugin.xml]: https://plugins.jetbrains.com/docs/intellij/plugin-configuration-file.html?from=IJPluginReadmeFile
|
||||
[docs:publishing]: https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginReadmeFile
|
||||
[docs:intellij-platform-gradle-plugin-docs]: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin.html?from=IJPluginReadmeFile
|
||||
[docs:intellij-platform-gradle-plugin-runIde]: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-tasks.html?from=IJPluginReadmeFile#runIde
|
||||
[docs:intellij-platform-gradle-plugin-verifyPlugin]: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-tasks.html?from=IJPluginReadmeFile#verifyPlugin
|
||||
[docs:logo]: https://plugins.jetbrains.com/docs/intellij/plugin-icon-file.html?from=IJPluginReadmeFile
|
||||
[docs:target-version]: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-dependencies-extension.html?from=IJPluginReadmeFile#target-versions
|
||||
[docs:testing]: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-dependencies-extension.html?from=IJPluginReadmeFile#testing
|
||||
|
||||
[file:build.gradle.kts]: ./build.gradle.kts
|
||||
[file:CHANGELOG.md]: ./CHANGELOG.md
|
||||
[file:gradle.properties]: ./gradle.properties
|
||||
[file:plugin.xml]: ./src/main/resources/META-INF/plugin.xml
|
||||
|
||||
[gh:code-samples]: https://github.com/JetBrains/intellij-sdk-code-samples
|
||||
|
||||
[gradle:lifecycle-tasks]: https://docs.gradle.org/current/userguide/java_plugin.html#lifecycle_tasks
|
||||
|
||||
[jb:github]: https://github.com/JetBrains/.github/blob/main/profile/README.md
|
||||
[jb:forum]: https://platform.jetbrains.com/
|
||||
[jb:quality-guidelines]: https://plugins.jetbrains.com/docs/marketplace/quality-guidelines.html
|
||||
[jb:paid-plugins]: https://plugins.jetbrains.com/docs/marketplace/paid-plugins-marketplace.html
|
||||
[jb:ipe]: https://jb.gg/ipe
|
||||
[jb:ui-guidelines]: https://jetbrains.github.io/ui
|
||||
Reference in New Issue
Block a user