2021-11-08 17:49:10 +01:00

3.0 KiB

Introduction

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

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

{type="tip"}

Configuring Plugin Projects Targeting AppCode

When targeting 2020.3, please see this migration guide.

{type="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.

{type="note"}

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/$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.

Available AppCode APIs

See AppCode Extension Point List for complete list.

{type="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.