szotaa / s2-intellij-plugin

s2-intellij-plugin

IntelliJ plugin enabling interaction with sabre2 tool via IDE

prerequisites

• JDK 11
• Docker
• IntelliJ IDE
• S2 tool container up and running
• S2 tool container volume must reflect your local project dir as s2 commands from IJ are executed in corresponding directory
• Gradle (optional, you can use gradlew wrapper or IntelliJ embedded gradle)

running plugin in development mode

run gradle runIde task either via executing gradle runIde command or select Gradle -> intellij -> runIde inside your Intellij instance

features

• subset of s2 commands added under mouse right click menu in current file view and project tree view
• ability to configure plugin variables via IJ Settings -> Tools -> Sabre2 Plugin Configuration
• communication with s2 tool deployed in local docker container via docker socket

other hints

getting started

• install stuff from prerequisites section
• import this repository into your IntelliJ
• read IJ plugin actions
• read IJ plugin extensions
• see s2_ij_plugin.action.BaseCliCommandWithOutputAction class javadoc
• see src/main/resources/META-INF/plugin.xml to understand how to add next actions
• see s2_ij_plugin.configuration.S2PluginSettingsState class javadoc to understand how to add your own configurable variables
• see s2_ij_plugin.docker.DockerAdapter class javadoc to understand how was communication with docker container implemented

useful links

• IntelliJ Plugin SDK samples
• Official IntelliJ plugin development documentation
• IntelliJ plugin development tutorial part 1
• IntelliJ plugin development tutorial part 2
• Make your IJ plugin configurable via IJ settings (used in s2_ij_plugin.configuration.*)
• docker client java (used in s2_ij_plugin.docker.*)
• tool window sample (used to print s2 command result inside IDE tab)