Skip to content

Files

Latest commit

 

History

History
executable file
·
60 lines (35 loc) · 2.11 KB

BUILD.md

File metadata and controls

executable file
·
60 lines (35 loc) · 2.11 KB

This document describes how to configure, run and deploy the Logtalk Plugin for IntelliJ.

Preliminary steps

  • Install the IntelliJ Gradle plugin.

  • Accomplish the preliminary steps for plugin development as recommended at the IntelliJ Platform SDK DevGuide. Particularly, verify that the IntelliJ Platform SDK is properly configured.

Configuring the project

  • From the IntelliJ File menu, select New -> Project....

  • In the panel of the left, select: IntelliJ Platform Plugin. In the panel of the right verify that the Project SDK corresponds to the IntelliJ SDK. Click Next.

  • In the Project name text field write: logtalk-idea. In the Project location text field write: <LOGTALK_DIR>/coding/idea. Click Finish.

Running the plugin

This plugin uses Gradle. In order to build and test the plugin from IntelliJ, open the Gradle view: (View menu, select Tool Windows -> Gradle). In the Gradle view, available Gradle tasks can be found under Tasks -> intellij.

To see the plugin in action, execute the runIde task. A new IntelliJ instance will run with the plugin installed.

Preparing the plugin for deployment.

  • Once the new version is looking good, update the version number and change notes at the plugin.xml deployment descriptor. It is located in the resources/META-INF/ directory.

  • In order to build the plugin, execute the buildPlugin Gradle task. A deployable plugin jar file will be generated under the build/distributions/ directory.

Deploying the plugin.

Deployment to the IntelliJ Plugin Repository

Local Deployment

Take the jar file and copy it to your local IntelliJ plugin repository (typically at ~/.IntelliJIdeaXXX/config/plugins). You may need to restart IntelliJ to see the changes applied. Do not forget to verify in the Settings dialog that the plugin is enabled.