Scala plugin for IntelliJ IDEA
Switch branches/tags
v1.2.1 v1.2 v1.1.3 v1.1.2 v1.1.1 v1.1 v1.0 temporary-travis-trigger-tag idea171.release-backup archive/212migrate archive/162.x-adkozlov archive/typeAnnotationRefactorings archive/tests_investigation archive/smartCaches archive/scalasphere archive/scalameta archive/scalaJSDynamic archive/revert-308-patch-1 archive/refactorings archive/injector archive/importAllMembers archive/idea171.x archive/idea171.release archive/idea171.eap archive/idea163.x archive/idea163.x-pavelfatin archive/idea163.x-niktrop archive/idea163.x-mutcianm archive/idea163.x-mavenfix archive/idea163.x-lugzan archive/idea163.x-jamesbrain2 archive/idea163.x-jamesbrain archive/idea163.x-feature/sbt-shell archive/idea163.x-alefas archive/idea163.release archive/idea163.release-lugzan archive/idea163.eap archive/idea163.eap-niktrop archive/idea163.eap-mutcianm archive/idea163.eap-lugzan archive/idea163.eap-katejim archive/idea163.eap-justin archive/idea163.eap-jamesbrian archive/idea163.eap-jamesbrain archive/idea163.eap-alefas2 archive/idea163.eap-alefas archive/idea163.eap-adkozlov archive/idea162.x archive/idea162.x-yalyshevant archive/idea162.x-niktrop archive/idea162.x-mutcianm archive/idea162.x-maven-resolver archive/idea162.x-lugzan archive/idea162.x-katejim archive/idea162.x-jamesbrain archive/idea162.x-integration archive/idea162.x-ilinum archive/idea162.x-cleanup archive/idea162.x-cleanup-refactoring archive/idea162.x-alefas archive/idea162.x-adkozlov archive/idea162.release archive/idea162.release.old archive/idea162.eap archive/idea162.eap.old archive/idea162.eap-niktrop archive/idea162.eap-mutcianm archive/idea162.eap-jamesbrain archive/idea162.eap-ilinum archive/idea16.x archive/idea16.release archive/idea16.eap archive/idea15.1.x archive/idea15.1.release archive/idea15.1.eap archive/idea15.x archive/idea15.release archive/idea15.eap archive/idea14.1.release archive/idea14.release archive/getCachedClass archive/feature/meta-tree-serialization archive/extension-api archive/dotty archive/dotty-parsers archive/breakpoints-test archive/baseTypes archive/backtickeds archive/akka-support archive/SCL10171 2018.3.2 2018.3.1 2018.2.11 2018.2.10.2 2018.2.10 2018.2.9.5 2018.2.9.3 2018.2.9 2018.2.8.1 2018.2.8
Nothing to show
Clone or download

official JetBrains project TC Build Status Travis Build Status Gitter

Scala Plugin for IntelliJ IDEA

Plugin that implements Scala, sbt, Play 2, SSP and Hocon support in IntelliJ IDEA.

General information

Setting up the project

In order to take part in Scala plugin development, you need to:

  1. Install IntelliJ IDEA 2017.1 or higher with a compatible version of Scala plugin

  2. Fork this repository and clone it to your computer

$ git clone
  1. Open IntelliJ IDEA, select File -> New -> Project from existing sources, point to the directory where Scala plugin repository is and then import it as sbt project.

  2. When importing is finished, in order to get artifacts and run configurations for IDEA project, go to the Scala plugin repo directory and run

$ git checkout .idea
  1. Open the sbt options (Preferences -> Build, Execution, Deployment -> sbt)
  • select Use sbt shell for build and import
  • in Global sbt settings -> JVM Options -> Maximum heap size, enter at least 2048
  1. Select the IDEA run configuration and select the Run or Debug button to build and start a development version of IDEA with the Scala plugin.

Browsing IntelliJ platform sources

When loading the plugin in sbt, the IntelliJ platform is downloaded to <home>/.ScalaPluginIC/sdk/<sdk version>/. When opening a platform API class you will see the option to "attach sources". Click it, navigate to the sdk directory and select, then choose "All".


To run tests properly, the plugin needs to be packaged. On the sbt shell:

  1. packagePluginCommunity
  2. runFastTests

The "fast tests" can take over an hour. To get a quick feedback on project health, run the "typeInference tests"

> testOnly org.jetbrains.plugins.scala.lang.typeInference.*

Travis CI

The project is configured to build and run the typeInference tests with Travis CI, which you can enable in your forks. The full test suite can't currently be run because Travis doesn't allow builds to take that long.

Running the plugin

Debugging mode

The easiest way to try your changes is typically to launch the IDEA run configuration which is created when you set up the project as described above.

As a standalone plugin

To run and distribute a modified version of the plugin in a regular IntelliJ instance, you need to package it.

  1. on the sbt shell, run packagePluginZip. This will output the generated plugin zip location (typically into <project directory>/target/
  2. In IntelliJ, open Preferences, section Plugins, choose "Install plugin from disk..." and navigate to the
  3. Restart IntelliJ