https://github.com/jetbrains/sbt-idea-example
SBT based IntellJ plugin template project
https://github.com/jetbrains/sbt-idea-example
idea-plugin intellij-plugin sbt
Last synced: about 1 month ago
JSON representation
SBT based IntellJ plugin template project
- Host: GitHub
- URL: https://github.com/jetbrains/sbt-idea-example
- Owner: JetBrains
- License: apache-2.0
- Created: 2015-10-14T13:27:08.000Z (almost 10 years ago)
- Default Branch: examples
- Last Pushed: 2025-01-22T11:34:44.000Z (9 months ago)
- Last Synced: 2025-05-28T07:02:40.485Z (4 months ago)
- Topics: idea-plugin, intellij-plugin, sbt
- Language: Scala
- Homepage:
- Size: 43 KB
- Stars: 34
- Watchers: 10
- Forks: 18
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sample IntelliJ platform plugin written in Scala
[](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
This is an example IJ plugin written in Scala and managed by SBT.
Apart from the basic IJ plugin structure,
this project also provides some example code to play with and demonstrates some IntelliJ platform API features.
Extended documentation on the build features such as packaging the artifact, uploading to a plugin marketplace,
etc. is covered by the [sbt-idea-plugin](https://github.com/JetBrains/sbt-idea-plugin) readme
## Quick Start
- Open the `build.sbt` file in IntelliJ IDEA as a project
- Install JDK 17 and set it in `File | Project Settings | Project | SDK`
- To run your plugin, run or debug the `myAwesomeFramework` run configuration
## Example build features
- `intellijBuild` key in build.sbt contains the version of the dependency on IDEA, you can change it.
- `intellijPlugins` key in build.sbt contains a dependency on the "Properties" IJ plugin
- there's an external library dependency that will be packaged into your plugin distribution
- Don't forget to replace the plugin name in build.sbt. You also need to change the name in resources/META-INF/plugin.xml.
## Example plugin components
- `PopupDialogAction` creates an action under the "Tools" menu
- `SimpleCompletionContributor` adds the "HELLO" completion item to the values of the properties files
- `FileOpenedListener` shows a popup when a file is opened in the editor
- `ApplicationHelloService` and `ProjectHelloService` show examples of IJ platform service components
- `MyToolWindowFactory` creates a new ToolWindow at the bottom of the window