2025-03-19 10:46:36 +01:00

3.6 KiB

AppCode Plugin Development

Introduction to developing plugins for AppCode.

Plugin projects targeting AppCode can be developed using IntelliJ IDEA with the .

With the release of AppCode 2022.3, we're sunsetting the product. Please see this blog post for details.

{style="warning"}

Configuring Plugin Projects Targeting AppCode

When targeting 2020.3, please see this migration guide.

{style="warning"}

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.

AppCode plugin development requires installing AppCode locally.

{style="note"}

The table below summarizes the attributes to set in the plugin project's Gradle build script. 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/$USERNAME$/Library/Application Support/JetBrains/Toolbox/apps/AppCode/ch-0/193.5662.55/AppCode.app/Contents.

runIde.ideDir

Path to locally installed target version of AppCode. For example, for macOS:

/Users/$USERNAME$/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 module dependency, or com.intellij.appcode plugin dependency for plugins targeting only versions 2020.3+.

Available AppCode APIs

See for the complete list.

{style="note"}

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.