IntelliJ Platform SDK DevGuide

Edit page

IntelliJ Platform Artifacts Repositories

JetBrains maintains public repositories that host artifacts related to the IntelliJ Platform, such as binaries and source code. These repositories make artifacts more accessible for plugin developers.

The IntelliJ Platform artifacts repositories are:

See the Maven coordinates section for details about specifying these artifacts.

Both the Releases and Snapshots repositories have two types of content:

  • Binary and source code artifacts for cross-platform, ZIP distributions of IntelliJ Platform-based IDEs, such as IntelliJ IDEA, CLion, Rider, and MPS. These artifacts are not intended to be accessed directly from a plugin project’s build.gradle file. The gradle-intellij-plugin will access them as-needed for a plugin project.
  • Artifacts for individual modules from the IntelliJ Platform. These may be downloaded, or accessed directly from a build.gradle file, as explained below.

Artifacts for IntelliJ Platform third-party dependencies are hosted at the Bintray repository. A link to this repository should be added to pom.xml/build.gradle files when individual modules from an IntelliJ Platform artifacts repository are used.

Using IntelliJ Platform Module Artifacts

IntelliJ Platform module artifacts are utilized by adding information to a project’s build.gradle file. More information about Gradle support is available in the IntelliJ IDEA Help documentation.

To setup dependencies on a module there are two types of information needed:

  1. Specify the corresponding repository URL for the artifact.
  2. Specify the Maven coordinates for the artifact.

Specify the Repository URL

The URL for the desired artifact needs to be added to a Maven or Gradle script:

  • For release versions, use https://www.jetbrains.com/intellij-repository/releases
  • For EAP snapshots, use https://www.jetbrains.com/intellij-repository/snapshots
  • For dependencies on individual modules from the IntelliJ Platform, also use https://jetbrains.bintray.com/intellij-third-party-dependencies

Specify the Maven Coordinates for the Artifact

Describing a desired IntelliJ Platform module artifact is done with Maven coordinates: groupId, artifactId, and version. The Maven coordinates are based on the names of modules.

The groupId for a module is the prefix com.jetbrains. concatenated with the first two parts of the module name.
For example, the module intellij.xml would have the groupId com.jetbrains.intellij.xml.

The artifactId is the second..n parts of the module name separated by “-“ characters.
For example, the module intellij.xml would have the artifactId xml. There are some special cases to artifactId names. If the second part of the module name is a common group like platform, vcs, or cloud, the second part of the module name is dropped, and the artifactId becomes the third..n parts of the module name, separated by “-“ characters. Portions of the module name expressed in camelCase format are divided and used in the artifactId as (all lower case) camel-case.

The table below shows some example module names and their corresponding groupId and artifactId.

Module Name groupId artifactId
intellij.java.compiler.antTasks com.jetbrains.intellij.java java-compiler-ant-tasks
intellij.java.debugger com.jetbrains.intellij.java java-debugger
intellij.platform.util com.jetbrains.intellij.platform util
intellij.platform.vcs.log com.jetbrains.intellij.platform vcs-log
intellij.spring com.jetbrains.intellij.spring spring
intellij.xml.impl com.jetbrains.intellij.xml xml-impl

The artifact version can be specified in one of several ways because each artifact at the Repository URLs has multiple versions available:

  • Specify release build versions as MAJOR[.MINOR][.FIX]. For example 14, or 14.1, or 14.1.1
  • Snapshot versions are specified as:
    • The snapshot of the most recent branch build is specified as BRANCH-EAP-SNAPSHOT. For example, 193-EAP-SNAPSHOT. There is only one of this type of build for each branch of each product.
    • The snapshot of the branch from which the next EAP/release build might be produced is specified as BRANCH.BUILD-EAP-CANDIDATE-SNAPSHOT. For example 193.4386-EAP-CANDIDATE-SNAPSHOT. There are multiple builds of this type, one for each build in each branch of every product.
    • The latest snapshot of a product is always specified as LATEST-EAP-SNAPSHOT. There is only one build of this type per product, and it is always the same as the BRANCH-EAP-SNAPSHOT for the newest branch of the product.
    • A snapshot of a branch is specified as BRANCH.BUILD.FIX-EAP-SNAPSHOT. For example, 193.4386.10-EAP-SNAPSHOT. There are many builds of this type for each branch of each product.

Example Artifact Specification

For example, to specify the jps-model-serialization module:

  • groupId = com.jetbrains.intellij.platform
  • artifactId = jps-model-serialization
  • classifier = ""
  • packaging = jar

Gradle Example for an Individual Module from the IntelliJ Platform

This section presents an example of using a Gradle script to incorporate an IntelliJ Platform module and repository in a build.gradle file. The example illustrates declaring the artifact URL, Maven coordinates, and version for the jps-model-serialization module artifact. There are two parts to the example: the repository and the dependency sections.

Repositories Section

This code snippet selects the release repository with the first URL, and repository of IntelliJ Platform dependencies with the second URL. The second URL is needed because this example selects individual modules.

repositories { maven { url "https://www.jetbrains.com/intellij-repository/releases" } maven { url "https://jetbrains.bintray.com/intellij-third-party-dependencies" } }

Dependencies Section

This code snippet specifies the desired module artifacts.

dependencies { compile "com.jetbrains.intellij.platform:jps-model-serialization:182.2949.4" compile "com.jetbrains.intellij.platform:jps-model-impl:182.2949.4" }

Note:

  • The artifact version (182.2949.4) must match in both statements.
  • In this example jps-model-serialization declares the APIs and jps-model-impl provides the implementation, so both are required dependencies.
Last modified: 22 April 2020