sbt

1. If no project is currently opened in IntelliJ IDEA, click Open on the welcome screen. Otherwise, select File | Open from the main menu.

2. In the dialog that opens, select a file that contains your sbt project description build.sbt. Click OK.

3. In the dialog that opens, click Select as Project.

   IntelliJ IDEA opens and syncs the sbt project in the IDE. If you need to adjust importing options when you open the project, refer to the sbt settings.

1. Create or open your sbt project.

2. In the Project tool window, in the source root directory, locate the build.properties file and open it in the editor.

3. In the editor explicitly specify the version of sbt that you want to use in the project.

   sbt.version=xxx

   note

   The newer sbt versions(1.0 +) will create the build.properties file automatically if it doesn't exist.

4. Reimport your project. (Click the in the sbt tool window.)

Reload an sbt project

1. In the sbt tool window, right-click a linked project.

2. From the context menu, select Reload project .

   On invoking this action, IntelliJ IDEA parses the project structure in the sbt tool window.

   IntelliJ IDEA cannot reload just a part of your project, it reloads the whole project including subprojects and dependencies.

tip

To reload all sbt projects, click on the toolbar, in the sbt tool window.

Configure the auto-reload

1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Build, Execution, Deployment | Build Tools.

   Alternatively, In the sbt tool window, click and select the Auto-Reload Settings option.

   

2. In the Build tools settings, specify the following options:

   

   • Reload changes in the build scripts: this option is selected by default. If you want to disable the auto-reload and manually control the reloading process, unselect this checkbox.

   • Any changes: select this option if you want to automatically reload the project after any changes you make to build.sbt or external changes.

     Every time you manually change the sbt build script in the editor, you need to load the changes. IntelliJ IDEA displays a nofication icon in the right part of the editor suggesting to Load sbt Changes made to the project (Ctrl+Shift+O ).

     

     With the Any changes option, IntelliJ IDEA reloads all the changes automatically.

   • External chages: when you select this option, IntelliJ IDEA automatically reloads the project only after the VCS changes and changes made to the build files outside the IDE.

1. Open a .scala file in the editor.

2. Specify a library you want to import.

3. Put the caret at the unresolved package and press Alt+Enter.

   

4. From the list of available intention actions, select Add sbt dependency.

5. Follow the steps suggested in the wizard that opens and click Finish.

   IntelliJ IDEA downloads the artifact, adds the dependency to the build.sbt file and to the sbt tool window.

• To start the sbt shell, press Ctrl+Shift+S (for Windows) or ⌘+⇧+S (for Mac OS X). Alternatively, click on the toolbar located at the bottom of the screen.

• To use the sbt shell for build and import procedures, select the Use sbt shell section located in the sbt settings and perform steps described in the Run a Scala application using the sbt shell section.

  note

  The sbt versions 0.13.16.+ / 1.0.3.+ are recommended.

• To use the sbt shell for debugging, refer to the debugging with sbt shell section.

• To run your tests from the sbt shell:

  1. Open a run/debug configuration (Run | Edit Configurations ).

  2. Create a test configuration and select the use sbt option from the available settings.

  tip

  You can also run test or test/Only command by entering it in the sbt shell.

• You can run sbt tasks by selecting the one you need from the sbt Tasks directory in the sbt tool window.

• You can manually enter your task (code completion is supported) in the sbt shell and run it directly from there.

• You can create a run configuration for a task. For example, you can create a custom task which is not part of the list of tasks located in the sbt tool window.

  1. Press Alt+Shift+F10 to open a run configuration.

  2. Specify the run configuration settings and click OK. If you need, you can add another configuration or a task to execute before running your configuration. Click in the Before Launch section and from the list that opens, select what you need to execute.

• When you work in the distraction-free mode (without toolbars and tool windows), you can run sbt tasks or commands from the Run Anything window. Press Ctrl twice to open it, type your command and press Enter.

IntelliJ IDEA displays results in the sbt shell window.

Access the sbt settings

1. Press Ctrl+Alt+S to open IDE settings and select Build, Execution, Deployment| sbt.

2. Alternatively, click on the toolbar of the sbt tool window to access the sbt settings.

3. On the sbt settings page, configure the following notable actions:

   • To delegate running builds to sbt, next to Use sbt shell, select the for imports and for builds options.

   • To debug your code via the sbt shell, select Enable debugging for sbt shell option that enables the debug button in the sbt shell tool window.

     For more information on debugging, see debugging with sbt.

   • To change the .ivy cache location in your project or set other sbt properties, use the VM parameters field.

   note

   If you want to configure the project reloading options for your project, refer to the build tools settings.

4. Click OK to save the changes.