From e4bee960df8fa0bb6af4b015ad07ea65f724e05e Mon Sep 17 00:00:00 2001 From: JohnHake Date: Fri, 31 Jan 2020 17:42:03 -0800 Subject: [PATCH] IJSDK-675 --- _SUMMARY.md | 2 +- products/app_code.md | 26 ++++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 products/app_code.md diff --git a/_SUMMARY.md b/_SUMMARY.md index dad608afc..5f4525b7c 100644 --- a/_SUMMARY.md +++ b/_SUMMARY.md @@ -232,7 +232,7 @@ * [Developing for Multiple Products](products/dev_alternate_products.md) * [Compatibility with Multiple Products](basics/getting_started/plugin_compatibility.md) * [Android Studio](products/android_studio.md) -* AppCode +* [AppCode](products/app_code.md) * [CLion](products/clion.md) * [DataGrip](products/data_grip.md) * [GoLand](products/goland.md) diff --git a/products/app_code.md b/products/app_code.md new file mode 100644 index 000000000..744a6c9eb --- /dev/null +++ b/products/app_code.md @@ -0,0 +1,26 @@ +--- +title: AppCode Plugin Development +--- + +## Introduction +Plugin projects targeting AppCode can be developed using IntelliJ IDEA with the `gradle-intellij-plugin`. + +## Configuring Plugin Projects Targeting AppCode +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 `build.gradle` file: + +| `gradle-intellij-plugin` Attribute | Attribute Value | +|-----------|-------| +| [`intellij.localPath`](https://github.com/JetBrains/gradle-intellij-plugin/blob/master/README.md#intellij-platform-properties) | Path to locally installed target version of AppCode. For example, for macOS:
`/Users//Library/Application Support/JetBrains/Toolbox/apps/AppCode/ch-0/193.5662.55/AppCode.app/Contents` | +| [`runIde.ideaDirectory`](https://github.com/JetBrains/gradle-intellij-plugin/blob/master/README.md#running-dsl) | Path to locally installed target version of AppCode. For example, for macOS:
`/Users//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](/basics/getting_started/plugin_compatibility.md#modules-specific-to-functionality) table, the `` tags must declare `com.intellij.modules.appcode`. + +## Available AppCode APIs +Use the [Exploring APIs as a Consumer](/basics/getting_started/plugin_compatibility.html#exploring-apis-as-a-consumer) process to identify the libraries in AppCode. +Test your plugin with any version of AppCode you wish to support.