2.9 KiB

title
AppCode Plugin Development

Introduction

Plugin projects targeting AppCode can be developed using IntelliJ IDEA with the gradle-intellij-plugin.

Tip

Qualifying Open Source projects can apply for free licenses of JetBrains products.

Configuring Plugin Projects Targeting AppCode

Warning

When targeting 2020.3, please see this migration guide.

The Gradle configuration of AppCode plugin projects uses neither Product-Specific nor IntelliJ IDEA Attributes. Instead, configure AppCode plugin projects to use the intellij.localPath attribute.

Note

AppCode plugin development requires installing AppCode locally.

The table below summarizes the gradle-intellij-plugin attributes to set in the plugin project's build.gradle file. Click on an entry in the table's Attribute column to go to the documentation about that attribute.

gradle-intellij-plugin Attribute Attribute Value
intellij.localPath Path to locally installed target version of AppCode. For example, for macOS:
/Users/<user name>/Library/Application Support/JetBrains/Toolbox/apps/AppCode/ch-0/193.5662.55/AppCode.app/Contents.
runIde.ideDirectory Path to locally installed target version of AppCode. For example, for macOS:
/Users/<user name>/Library/Application Support/JetBrains/Toolbox/apps/AppCode/ch-0/193.5662.55/AppCode.app/Contents.

The dependency on the AppCode APIs must be declared in the plugin.xml file. As described in Modules Specific to Functionality table, the <depends> tags must declare com.intellij.modules.appcode.

Available AppCode APIs

Use the Exploring APIs as a Consumer process to identify the libraries in AppCode. Test your plugin with any version of AppCode you wish to support.