This project requires JVM version of at least 1.7

gradle-intellij-plugin

This plugin allows you to build plugins for IntelliJ platform using specific IntelliJ SDK and bundled plugins.

The plugin adds extra IntelliJ-specific dependencies, patches processResources tasks to fill some tags (name, version) in plugin.xml with appropriate values, patches compile tasks to instrument code with nullability assertions and forms classes made with IntelliJ GUI Designer and provides some build steps which might be helpful while developing plugins for IntelliJ platform.

Usage

Gradle >= 2.1

buildscript {
  repositories {
    maven { url 'http://dl.bintray.com/jetbrains/intellij-plugin-service' }
  }
}

plugins {
  id "org.jetbrains.intellij" version "0.1.10"
}

Gradle < 2.1

buildscript {
  repositories {
    maven {
      url "https://plugins.gradle.org/m2/"
    }
    maven { 
      url 'http://dl.bintray.com/jetbrains/intellij-plugin-service' 
    }
    
  }
  dependencies {
    classpath "gradle.plugin.org.jetbrains:gradle-intellij-plugin:0.1.10"
  }
}

apply plugin: 'org.jetbrains.intellij'

Snapshot

buildscript {
  repositories {
    maven {
      url "https://oss.sonatype.org/content/repositories/snapshots/"
    }
    maven { 
      url 'http://dl.bintray.com/jetbrains/intellij-plugin-service' 
    }
    
  }
  dependencies {
    classpath "org.jetbrains.intellij.plugins:gradle-intellij-plugin:0.2.0-SNAPSHOT"
  }
}

apply plugin: 'org.jetbrains.intellij'

Tasks

Plugin introduces following tasks

• prepareSandbox creates proper structure of plugin and fills sandbox directory with it
• buildPlugin assembles plugin and prepares zip archive for deployment
• runIdea executes IntelliJ IDEA instance with the plugin you are developing installed in
• publishPlugin uploads plugin distribution archive to http://plugins.jetbrains.com

Configuration

Plugin provides following options to configure target IntelliJ SDK and build archive

• intellij.version defines the version of IDEA distribution that should be used as a dependency. The option accepts build numbers, version numbers and two meta values LATEST-EAP-SNAPSHOT, LATEST-TRUNK-SNAPSHOT.

Value may have `IC-` or `IU-` prefix in order to define IDEA distribution type.

**Default value**: `LATEST-EAP-SNAPSHOT`

• intellij.type defines the type of IDEA distribution: IC for community version and IU for ultimate.
  
  Default value: IC

• intellij.plugins defines the list of bundled IDEA plugins and plugins from idea repository that should be used as dependencies in format org.plugin.id:version. E.g. plugins = ['org.intellij.plugins.markdown:8.5.0.20160208']. If version is not set then bundled plugin will be used.
  
  Default value: <empty>

• intellij.pluginName is used for naming target zip-archive and defines the name of plugin artifact. of bundled IDEA plugins that should be used as dependencies.
  
  Default value: $project.name

• intellij.sandboxDirectory defines path of sandbox directory that is used for running IDEA with developing plugin.
  
  Default value: $project.buildDir/idea-sandbox

• intellij.instrumentCode defines whether plugin should instrument java classes with nullability assertions. Also it might be required for compiling forms created by IntelliJ GUI designer.
  
  Default value: true

• intellij.updateSinceUntilBuild defines whether plugin should patch plugin.xml with since and until build values, if true then IntelliJIDEABuildNumber will be used as a since value and IntelliJIDEABranch.9999 will be used as an until value.
  
  Default value: true

• intellij.sameSinceUntilBuild defines whether plugin should patch plugin.xml with "open" until build. if true then the same IntelliJIDEABuildNumber will be used as a since value and as an until value, which is useful for building plugins against EAP IDEA builds.
  
  Default value: false

• intellij.downloadSources defines whether plugin should download IntelliJ sources while initializing Gradle build. Since sources are no needed while testing on CI, you can set it to false for particular environment.
  
  Default value: true

• intellij.systemProperties defines the map of system properties which will be passed to IDEA instance on executing runIdea task and tests.
  Also you can use intellij.systemProperty(name, value) method in order to set single system property.
  
  Default value: []

• intellij.alternativeIdePath – absolute path to the locally installed JetBrains IDE. It makes sense to use this property if you want to test your plugin in WebStorm or any other non-IDEA JetBrains IDE. Empty value means that the IDE that was used for compiling will be used for running/debugging as well.
  
  Default value: <empty>

Publishing plugin

• intellij.publish.username your login at JetBrains plugin repository.
• intellij.publish.password your password at JetBrains plugin repository.
• intellij.publish.channel defines channel to upload, you may use any string here, empty string means default channel.

Available in SNAPSHOT only

• intellij.publish.channels defines several channels to upload, you may use any string here, default string means default channel.
  
  Default value: <empty>

build.gradle

plugins {
  id "org.jetbrains.intellij" version "0.1.10"
}

intellij {
  version 'IC-2016.1'
  plugins = ['coverage', 'org.intellij.plugins.markdown:8.5.0.20160208']
  pluginName 'MyPlugin'

  publish {
    username 'zolotov'
    password 'password'
    channel 'nightly'
  } 
}

Examples

As examples of using this plugin you can check out following projects:

• Go plugin and its TeamCity build configuration
• Erlang plugin and its TeamCity build configuration
• Rust plugin and its TeamCity build configuration
• AWS CloudFormation plugin and its TeamCity build configuration
• Bash plugin and its TeamCity build configuration
• Perl5 plugin and its Travis configuration file
• Android Drawable Importer plugin
• Android Material Design Icon Generator plugin
• EmberJS plugin
• GCloud plugin
• HCL plugin
• Robot plugin
• TOML plugin
• SQLDelight Android Studio Plugin
• https://github.com/breandan/idear
• https://github.com/pedrovgs/AndroidWiFiADB
• https://github.com/SonarSource/sonar-intellij
• IdeaVim plugin and its TeamCity build configuration
• Adb Idea is configured to build and run against stable, beta or preview (canary) releases of Android Studio
• Gerrit uses Travis CI inclusive automated publishing of releases to GitHub and JetBrains plugin repository (triggered by version tag creation)
• .ignore
• Minecraft Development and its TeamCity build configuration

License

Copyright 2016 org.jetbrains.intellij.plugins

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.