You are viewing the documentation for the 2.5.14 release in the 2.5.x series of releases. The latest stable release series is 3.0.x.

§Setting up your preferred IDE

Working with Play is easy. You don’t even need a sophisticated IDE, because Play compiles and refreshes the modifications you make to your source files automatically, so you can easily work using a simple text editor.

However, using a modern Java or Scala IDE provides cool productivity features like auto-completion, on-the-fly compilation, assisted refactoring and debugging.

§Eclipse

§Setup sbteclipse

Integration with Eclipse requires sbteclipse 4.0.0 or newer.

addSbtPlugin("com.typesafe.sbteclipse" % "sbteclipse-plugin" % "4.0.0")

You must compile your project before running the eclipse command. You can force compilation to happen when the eclipse command is run by adding the following setting:

// Compile the project before generating Eclipse files, so that generated .scala or .class files for views and routes are present
EclipseKeys.preTasks := Seq(compile in Compile)

If you have Scala sources in your project, you will need to install Scala IDE.

If you do not want to install Scala IDE and have only Java sources in your project, then you can set the following:

EclipseKeys.projectFlavor := EclipseProjectFlavor.Java           // Java project. Don't expect Scala IDE
EclipseKeys.createSrc := EclipseCreateSrc.ValueSet(EclipseCreateSrc.ManagedClasses, EclipseCreateSrc.ManagedResources)  // Use .class files instead of generated .scala files for views and routes

§Generate configuration

Play provides a command to simplify Eclipse configuration. To transform a Play application into a working Eclipse project, use the eclipse command:

[my-first-app] $ eclipse

If you want to grab the available source jars (this will take longer and it’s possible a few sources might be missing):

[my-first-app] $ eclipse with-source=true

Note if you are using sub-projects with aggregate, you would need to set skipParents appropriately in build.sbt:

EclipseKeys.skipParents in ThisBuild := false

or from the play console, type:

[my-first-app] $ eclipse skip-parents=false

You then need to import the application into your Workspace with the File/Import/General/Existing project… menu (compile your project first).

To debug, start your application with sbt -jvm-debug 9999 run and in Eclipse right-click on the project and select Debug As, Debug Configurations. In the Debug Configurations dialog, right-click on Remote Java Application and select New. Change Port to 9999 and click Apply. From now on you can click on Debug to connect to the running application. Stopping the debugging session will not stop the server.

Tip: You can run your application using ~run to enable direct compilation on file change. This way scala template files are auto discovered when you create a new template in view and auto compiled when the file changes. If you use normal run then you have to hit Refresh on your browser each time.

If you make any important changes to your application, such as changing the classpath, use eclipse again to regenerate the configuration files.

Tip: Do not commit Eclipse configuration files when you work in a team!

The generated configuration files contain absolute references to your framework installation. These are specific to your own installation. When you work in a team, each developer must keep his Eclipse configuration files private.

§IntelliJ IDEA

Intellij IDEA lets you quickly create a Play application without using a command prompt. You don’t need to configure anything outside of the IDE, the SBT build tool takes care of downloading appropriate libraries, resolving dependencies and building the project.

Before you start creating a Play application in IntelliJ IDEA, make sure that the latest Scala Plugin is installed and enabled in IntelliJ IDEA. Even if you don’t develop in Scala, it will help with the template engine and also resolving dependencies.

To create a Play application:

Open New Project wizard, select Sbt under Scala section and click Next.
Enter your project’s information and click Finish.

You can also import an existing Play project.

To import a Play project:

Open Project wizard, select Import Project.
In the window that opens, select a project you want to import and click OK.
On the next page of the wizard, select Import project from external model option, choose SBT project and click Next.
On the next page of the wizard, select additional import options and click Finish.

Tip: you can download and import one of our starter projects or either one of the example projects.

Check the project’s structure, make sure all necessary dependencies are downloaded. You can use code assistance, navigation and on-the-fly code analysis features.

You can run the created application and view the result in the default browser http://localhost:9000. To run a Play application:

Create a new Run Configuration – From the main menu, select Run -> Edit Configurations
Click on the + to add a new configuration
From the list of configurations, choose “SBT Task”
In the “tasks” input box, simply put “run”
Apply changes and select OK.
Now you can choose “Run” from the main Run menu and run your application

You can easily start a debugger session for a Play application using default Run/Debug Configuration settings.

For more detailed information, see the Play Framework 2.x tutorial at the following URL:

https://www.jetbrains.com/idea/help/getting-started-with-play-2-x.html

§Navigate from an error page to the source code

Using the play.editor configuration option, you can set up Play to add hyperlinks to an error page. This will link to runtime exceptions thrown when Play is running development mode.

Note: Play can only display runtime exceptions, and compilation errors (even involving Twirl templates or routes) cannot be displayed in an error page.

You can easily navigate from error pages to IntelliJ directly into the source code, by using IntelliJ’s “remote file” REST API with the built in IntelliJ web server on port 63342.

Enable the following line in application.conf to provide hyperlinks:

play.editor="http://localhost:63342/api/file/?file=%s&line=%s"

You can also set play.editor from build.sbt:

fork := true // required for "sbt run" to pick up javaOptions

javaOptions += "-Dplay.editor=http://localhost:63342/api/file/?file=%s&line=%s"

or set the PLAY_EDITOR environment variable:

PLAY_EDITOR="http://localhost:63342/api/file/?file=%s&line=%s"

§Netbeans

§Generate Configuration

Play does not have native Netbeans project generation support at this time, but there is a Scala plugin for NetBeans which can help with both Scala language and SBT:

https://github.com/dcaoyuan/nbscala

There is also a SBT plugin to create Netbeans project definition:

https://github.com/dcaoyuan/nbsbt

§ENSIME

§Install ENSIME

Follow the installation instructions at https://github.com/ensime/ensime-emacs.

§Generate configuration

Edit your project/plugins.sbt file, and add the following line (you should first check https://github.com/ensime/ensime-sbt for the latest version of the plugin):

addSbtPlugin("org.ensime" % "ensime-sbt" % "0.2.3")

Start SBT:

$ sbt

Enter ‘gen-ensime’ at the play console. The plugin should generate a .ensime file in the root of your Play project.

[MYPROJECT] $ gen-ensime
[info] Gathering project information...
[info] Processing project: ProjectRef(file:/Users/aemon/projects/www/MYPROJECT/,MYPROJECT)...
[info]  Reading setting: name...
[info]  Reading setting: organization...
[info]  Reading setting: version...
[info]  Reading setting: scala-version...
[info]  Reading setting: module-name...
[info]  Evaluating task: project-dependencies...
[info]  Evaluating task: unmanaged-classpath...
[info]  Evaluating task: managed-classpath...
[info] Updating {file:/Users/aemon/projects/www/MYPROJECT/}MYPROJECT...
[info] Done updating.
[info]  Evaluating task: internal-dependency-classpath...
[info]  Evaluating task: unmanaged-classpath...
[info]  Evaluating task: managed-classpath...
[info]  Evaluating task: internal-dependency-classpath...
[info] Compiling 5 Scala sources and 1 Java source to /Users/aemon/projects/www/MYPROJECT/target/scala-2.9.1/classes...
[info]  Evaluating task: exported-products...
[info]  Evaluating task: unmanaged-classpath...
[info]  Evaluating task: managed-classpath...
[info]  Evaluating task: internal-dependency-classpath...
[info]  Evaluating task: exported-products...
[info]  Reading setting: source-directories...
[info]  Reading setting: source-directories...
[info]  Reading setting: class-directory...
[info]  Reading setting: class-directory...
[info]  Reading setting: ensime-config...
[info] Wrote configuration to .ensime

§Start ENSIME

From Emacs, execute M-x ensime and follow the on-screen instructions.

That’s all there is to it. You should now get type-checking, completion, etc. for your Play project. Note, if you add new library dependencies to your play project, you’ll need to re-run “gen-ensime” and re-launch ENSIME.

§More Information

Check out the ENSIME README at https://github.com/ensime/ensime-emacs. If you have questions, post them in the ensime group at https://groups.google.com/forum/?fromgroups=#!forum/ensime.

§All Scala Plugins if needed

Eclipse Scala IDE: http://scala-ide.org/
NetBeans Scala Plugin: https://github.com/dcaoyuan/nbscala
IntelliJ IDEA Scala Plugin: http://blog.jetbrains.com/scala/
ENSIME - Scala IDE Mode for Emacs: https://github.com/aemoncannon/ensime
(see below for ENSIME/Play instructions)

Next: Anatomy of a Play application