IntelliJ Platform Plugin SDK Help

Android Studio Plugin Development

Introduction

Android Studio plugins extend or add functionality to the Android Studio IDE. Plugins can be written in Kotlin or Java, or a mix of both, and are created using IntelliJ IDEA and the IntelliJ Platform. It's also helpful to be familiar with Java Swing. Once completed, plugins can be packaged and distributed at JetBrains Plugin Repository.

Android Studio plugins are not Android modules or apps to run in the Android operating system, such as smartphones or tablets.

Configuring IntelliJ Platform Projects for Android Studio Plugin Development

To create a new Android Studio plugin project, follow the tutorial on the Getting Started with Gradle page. The tutorial produces a skeleton project suitable to use as a starting point for an Android Studio plugin. On the New Project Configuration Screen of the New Project Wizard tutorial, choose Gradle from the product category pane as described in the tutorial, not Android. Some minor modifications to the skeleton project are needed, as discussed below.

Matching Versions of the IntelliJ Platform with the Android Studio Version

For API compatibility, it is essential to match the version of the IntelliJ Platform APIs used for plugin development with the target version of Android Studio. The version number of Android Studio contains the version of the underlying IntelliJ Platform APIs that were used to build it.

To find the version of the IntelliJ Platform used to build Android Studio, use the Android Studio About dialog screen. An example is shown below. In this case, the (BRANCH.BUILD.FIX) version of the IntelliJ Platform is 191.8026.42, which corresponds to the IntelliJ IDEA version 2019.1.4. The build.gradle configuration steps section below explains how to set the IntelliJ Platform version to match the target version of Android Studio.

Example Android Studio About Dialog

Configuring the Plugin build.gradle File

The use-case of developing for a non-IntelliJ IDEA IDE is reviewed in the Plugins Targeting Alternate IntelliJ Platform-Based IDEs section of the Configuring Gradle for IntelliJ Platform Plugins page. The particular example in that section discusses configuring a plugin project for PhpStorm, so the details for an Android Studio plugin project are reviewed here.

Here are the steps to configure the build.gradle file for developing a plugin to target Android Studio:

  • The Gradle plugin attributes describing the configuration of the IntelliJ Platform used to build the plugin project must be explicitly set. Continuing with the example above, set the intellij.version value to 191.8026.42. Alternatively, specify intellij.localPath to refer to a local installation of Android Studio.

  • Android Studio plugin projects that use APIs from the android plugin must declare a dependency on that plugin. Declare the dependency in build.gradle using the Gradle plugin intellij.plugins attribute, which in this case lists the directory name of the plugin.

  • The best practice is to use the target version of Android Studio as the IDE Development Instance. Set the Development Instance to the (user-specific) absolute path to the target Android Studio application.

The snippet below is an example of configuring the Setup and Running DSLs in a build.gradle specific to developing a plugin targeted at Android Studio.

intellij { // Define IntelliJ Platform against which to build the plugin project. version '191.8026.42' // Same IntelliJ IDEA version (2019.1.4) as target 3.5 Android Studio type 'IC' // Use IntelliJ IDEA CE because it's the basis of the IntelliJ Platform // Require the Android plugin, Gradle will match the plugin version to intellij.version plugins 'android' } runIde { // Absolute path to installed target 3.5 Android Studio to use as IDE Development Instance // The "Contents" directory is macOS specific. ideDirectory '/Applications/Android Studio.app/Contents' }

Configuring the Plugin plugin.xml File

When using APIs from the android plugin, declare a dependency:

<depends>org.jetbrains.android</depends>

As discussed in the Plugin Dependencies section of this guide, a plugin's dependency on Modules Specific to Functionality must be declared in plugin.xml. When using Android Studio-specific features (APIs), a dependency on com.intellij.modules.androidstudio must be declared as shown in the code snippet below. Otherwise, if only general IntelliJ Platform features (APIs) are used, then a dependency on com.intellij.modules.platform must be declared as discussed in Plugin Compatibility with IntelliJ Platform Products.

<depends>com.intellij.modules.androidstudio</depends>

Android Specific Extension Points

See Android Plugin section in Extension Point List.

Additional Articles and Resources

Open Source Plugins for Android Studio

When learning new development configurations, it is helpful to have some representative projects for reference:

FAQ

How To Sync Gradle Project

Use com.android.tools.idea.gradle.project.sync.GradleSyncInvoker.requestProjectSync() for programmatic synchronization.

Last modified: 12 May 2021