Emacs Power for Scala Development: Introduction

hal

I’ve blogged before about using Emacs for Scala, but I’ve recently upgraded my Emacs-fu a bit further, and wanted to share the latest state of all the power of Emacs available for Scala development (along with a few loosely related power tools).

Emacs is an entirely incredible editor. I’ve had a long and sometimes fairly distant relationship with Emacs over the years.

For a long time I was strictly a Vim guy, finding in it’s conciseness and simplicity all the power I needed. It’s still my goto tool for a quick-and-dirty edit, and is, I know, capable of much more than I do with it.

I had used Emacs, but found it too much for me in most cases. I still pulled it out once in a while, but it wasn’t until I started doing more Lisp work (and a bit of Prolog) that I really got it. Emacs isn’t just an editor at all — it’s practically an operating system, with it’s own programming language (eLisp) to boot!

It’s great power comes from two things, in my view: one is that it’s a keyboard editor, e.g. you can do everything emacs does entirely with the keyboard, no mouse required.

I’m no mouse luddite (actually, I prefer trackpads and trackballs), but I do fully recognize that for sheer editing efficiency, there’s nothing so fast as they keyboard, especially if you’re using “normal” keys (e.g. the typewriter set, not a bunch of extra F-keys that might not be on all keyboards). The difference is not small, it’s huge. You can literally work many times faster with just the keyboard — this is covered extensively elsewhere on the web, have a look around.

I’ve also blogged about why I prefer Scala as my go-to language, so I’ll just refer you to my other posts if you’re interested. Suffice it to say I’ve tried quite a few languages, and Scala blows the doors off the lot of them for just plain practicality.

So, how do we put the power of Emacs with the practicality of Scala?

You can start with nothing, actually. Straight Emacs, right out of the box, makes an awesome Scala editor, as Scala files are just plain text after all, and plain text is Emacs’ middle name.

You can take it much further, however, starting with Scala Mode, which gives you basic syntax highlighting, making it a bit faster and easier to read your Scala source.

Beyond that are tools to help navigate and refactor. My favorite of these is Ensime, as I’ve discussed before.

The latest version (I’m using 0.9.8.9 with Scala 2.10) is getting pretty darn good. By this I mean it’s giving my other go-to tool for Scala development, Jetbrains’ IntelliJ IDEA, a run for it’s money.

Not in the ”pretty” department – that’s not what Emacs does. Just in the plain capability mode. It was always miles ahead in terms of speed — the latest version 13 early-access of IntelliJ is much better speed-wise than it used to be, but Emacs still runs circles around it. The reason is simple: Emacs is trying to do far less than IntelliJ is — it’s not an IDE, per se, just an editor.

Even running Ensime, though, which gives it most of the support of a true Scala IDE, it’s still much faster in just sheer editing, and about the same on doing various refactors, finding imports, and so forth.

It’s been said that Emacs is like a light-saber. You don’t just go to the store and buy one, you build your own. I’ve been doing just that, refining my Emacs configuration to do exactly what I want. It’s almost unfair to call what Emacs does “configuration”, though — it’s much more. I have a series of a dozen or so entire packages of elisp code in my .emacs.d directory (it’s all on github, right here, if you want to have a look).

This not only set up my emacs with Ensime, Scala mode, and all the goodness I need for banging out Scala fast and accurate, it also has tools for helping with file navigation, beyond what Ensime does already for navigating Scala source.

My favorite at the moment is dirtree, which gives me a simple tree view of selected directories, and lets me whip through them effortlessly, all with just the keyboard. Sunrise commander is another much more powerful alternative — I’ve got both configured, and I jump to Sunrise when I need to really work with directories more than just navigate around quickly. Either of these are worth of their own blog posts, and may well get them in the future.

On the right is a screenshot of Dirtree, with a Scala file (using Ensime and Scala mode) open in the other buffer.

dirtree 300x162 Emacs Power for Scala Development: Introduction

A screenshot of Dirtree in Emacs with Scala Mode and Ensime

You can see at the bottom of the screen that I’m on the master branch for my git repo, and that Ensime is aware I’m editing a Scala file. If any lines have an error, I see them immediately. For example, kill an import statement, and the resulting error is highlighted (and the error itself, an unknown type, shown in the minibuffer at the bottom of the screen):

witherror 300x162 Emacs Power for Scala Development: Introduction

An error highlighted in Ensime after deleting an import

Then I can hit C-c C-r t (this is easier than it looks, I just hold down Control, hit c, then r, release control, then hit t. It takes way less time to do it than describe it). I get a popup of suggested imports, like so:

 

importpopup 300x162 Emacs Power for Scala Development: Introduction

Import popup in Ensime in Emacs for Scala

The first one is the right one, so I just hit enter, but there’s myriad ways to navigate to the right one if it’s not the top of the list. When I hit enter, my import is back, and my error goes away. It’s very, very fast.

One thing IntelliJ had was the ability to quickly and easily move around lines or blocks of Scala code, so I added move-text, a package that I’ve bound to Meta-Up, Meta-Down, allowing the same quick and easy re-organization of lines of code without having to cut and paste.

For git access, I can drop to the command-line of course, and often do (I use Zsh, which has excellent integrated git command-line tool support), or I can do that from — you guessed it — Emacs. I use Magit, which gets me quick and easy access to git right from within Emacs.

If i need to track my time (if I’m developing for a client, for example), I can stay right in Emacs and use the amazing Org-mode, from organizing the tasks in my project, though tracking my time, all the way up to preparing my time report for billing.

One of the benefits of doing everything in Emacs is that I can use a common set of keybindings (which determine what keys do what in the various Emacs modes). This means once my fingers learn what they’re doing, I stop thinking about keyboard shortcuts and just burn out the work. It becomes unconscious after a while, I don’t think “oh, I need to get to the end of the line”, I’ve already hit C-e by the time the thought starts to register. My fingers don’t leave the home row for minutes at a time, and the peck-peck… mouse… peck-peck… mouse drudgery just stops. Emacs is fast enough to not break my flow of coding, so put it all together and I can get more done in an hour than I could have in three with a different toolset.

I’m working on a series of posts to show all of this in detail, from the setup of your own Emacs through the cloning of a Scala project, through planning a series of edits to the project with Org-mode, and tracking items to do and time spent on them, all the way through refactoring, running tests, pushing changes to github, to generating my time to send a bill, all in “real-time”.

In the meantime, here’s a short video showing me correcting an error in Emacs/Ensime, as I describe above.


Principles and Practices


Tired of the Software Development Grind? Know it can be done better? Check out my book: Principles and Practices of Software Craftsmanship or sign up for my Craftsmanship Dispatches newsletter.

Posted in Emacs, Scala  |  4 Comments
  • [...] followup to my post Introducing Emacs Power for Scala Development, here’s how to set up a new project and get [...]

  • eric271828 says:

    I work between Emacs and IntelliJ pretty seemlessly. Bread and butter editing is done in IntelliJ, which has Emacs keybindings that I’ve tweaked to match my Emacs customizations (generally after the recommendations of Steve Yegge). But then I can drop into Emacs for the same file and line when I need to do more heavy duty transformations. Here’s the IntelliJ setup:
    File > Preferences > External Tools
    Program: /Applications/Emacs.app/Contents/MacOS/Emacs
    Parameters: +$LineNumber$ “$FilePath$”
    Working Directory: /Applications/Emacs.app/Contents/MacOS
    Then I map a key to open this (Cmd-E)
    On the emacs side, I have the following to pick up changes to an open buffer that were made in Intellij
    (global-auto-revert-mode 1)
    —–

    • mnash says:

      Eric, thanks for the tips – the global auto revert is handy, I might put that in my setup as well. I do find IntelliJ still has some great features, so being able to choose and flip between Emacs and IntelliJ gets the best of both worlds.

  • Very informative article post.Really thank you! Will read on…