/ensime

Enhanced Scala Interaction Mode for Emacs

Primary LanguageEmacs LispGNU General Public License v3.0GPL-3.0

ENSIME

the ENhanced Scala Interaction Mode for Emacs

Features

  • Highlight errors and warnings in your code buffers.
  • Inspect the type of any expression.
  • Browse packages
  • Completion-on-demand for variables, methods, constructors, etc.
  • Jump to symbol definitions.
  • Automated Refactorings (rename, organize imports, extract method...)
  • Source Formatting
  • Finds sbt,Maven,Ivy dependencies
  • Scala REPL
  • Scala Debugger
  • Embedded sbt shell

Check out this (rather old)video or this one showcasing debugger support

System Requirements

  • Emacs 22 or later.
  • Unix-like OS or Windows. Note that you'll need to use bin/server.bat on windows.
  • Java Runtime
  • Scala 2.8 compatible source and libraries. ENSIME is built against the 2.8 nightly Scala releases.

Documentation

Quick Start

1) Install scala-mode

ENSIME is designed to compliment scala-mode (or any other scala language mode). scala-mode can be found in the Scala distribution under ./misc/scala-tool-support/emacs/

2) Install ensime-mode

Download the ENSIME distribution from the github downloads page. Unpack the ENSIME distribution into a directory of your choosing.

Add the following lines to your .emacs file: (require 'scala-mode) (add-to-list 'auto-mode-alist '("\.scala$" . scala-mode)) (add-to-list 'load-path "ENSIME_ROOT/elisp/") (require 'ensime) (add-hook 'scala-mode-hook 'ensime-scala-mode-hook) ;; MINI HOWTO: open .scala file. Ensure bin/server.sh is executable. M-x ensime

3) Verify Permissions

Verify that the startup script (usually bin/server.sh) has executable permissions.

4) Create Project

In Emacs, execute M-x ensime-config-gen. Follow directions in the mini-buffer to create a .ensime file for your project..

5) Start ENSIME

Execute M-x ensime