Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

268 lines (195 sloc) 7.755 kb

Scalariform

Scalariform is a code formatter for Scala 2.8. It is both a stand-alone command line tool / library and an Eclipse plug-in. Currently, Scalariform supports only a limited set of options, although it is intended to be compatible with the recommendations of the Scala Style Guide (see below). Please let me know what other features people would like.

Scalariform is licenced under The MIT Licence.

Installation in Eclipse

In Eclipse 3.5, install the latest nightly build of Scala IDE for Eclipse using the update site mechanism:

http://download.scala-ide.org/nightly-update-master-trunk

(See http://www.assembla.com/wiki/show/scala-ide/Requirements_and_Installation for more detailed instructions.)

Then install Scalariform from this update site:

http://scalariform.googlecode.com/svn/trunk/update-site/

To format:

  • Right click in the editor -> Format Scala Source Code, or
  • Press Ctrl-Shift-D

To configure preferences, go to Window -> Preferences -> Scala -> Scala Formatter Preferences

Command line tool

Scalariform can be used as a stand-alone command line utility. Sample script:

#!/bin/bash
scala -cp /path/to/scalariform-X.Y.Z.jar scalariform.commandline.Main "$@"

Usage:

scalariform [options] [files...]

Options:
  --help, -h       Show help
  --inPlace, -i    Replace the input file(s) in place with a formatted version.
  --test, -t       Check the input(s) to see if they are correctly formatted, return a non-zero error code if not.
  --verbose -v     Verbose output

Preferences:
  [+|-]alignParameters                Enable/disable Align parameters on different lines in the same column
  [+|-]compactStringConcatenation     Enable/disable Omit spaces when formatting a '+' operator on String literals
  [+|-]doubleIndentClassDeclaration   Enable/disable Double indent either a class's parameters or its inheritance list
  -indentSpaces=[1-10]                Set Number of spaces to use for indentation
  [+|-]preserveSpaceBeforeArguments   Enable/disable Preserve a space before a parenthesis argument
  [+|-]rewriteArrowSymbols            Enable/disable Replace arrow tokens with unicode equivalents: => with ⇒, and <- with ←
  [+|-]spaceBeforeColon               Enable/disable Add a space before colons

Examples:
 scalariform +spaceBeforeColon -alignParameters -indentSpaces=2 --inPlace foo.scala
 find . -name '*.scala' | xargs scalariform +rewriteArrowSymbols --verbose --test
 echo 'class A ( n  :Int )' | scalariform

Preferences

alignParameters

Default: false

Align class/function parameters in the same column. For example, if false, then:

class Person(name: String,
  age: Int,
  birthdate: Date,
  astrologicalSign: String,
  shoeSize: Int,
  favoriteColor: java.awt.Color)

If true, then:

class Person(name: String,
             age: Int,
             birthdate: Date,
             astrologicalSign: String,
             shoeSize: Int,
             favoriteColor: java.awt.Color)

compactStringConcatenation

Default: false

Omit spaces when formatting a '+' operator on String literals". For example, If false, then:

"Hello " + name + "!"

If true, then:

"Hello "+name+"!"

The Scala Style Guide recommends that operators, "should always be invoked using infix notation with spaces separated the target".

doubleIndentClassDeclaration

Default: false

With this set to true, class (and trait / object) declarations will be formatted as recommended by the Scala Style Guide. That is, if the declaration section spans multiple lines, it will be formatted so that either the parameter section or the inheritance section is doubly indented. This provides a visual distinction from the members of the class. For example:

class Person(
  name: String,
  age: Int,
  birthdate: Date,
  astrologicalSign: String,
  shoeSize: Int,
  favoriteColor: java.awt.Color)
    extends Entity
    with Logging
    with Identifiable
    with Serializable {
  def firstMethod = ...
}

Or:

class Person(
    name: String,
    age: Int,
    birthdate: Date,
    astrologicalSign: String,
    shoeSize: Int,
    favoriteColor: java.awt.Color) {
  def firstMethod = ...
}

indentSpaces

Default: 2

The number of spaces to use for each level of indentation.

preserveSpaceBeforeArguments

Default: false

If true, the formatter will keep an existing space before a parenthesis argument. For example:

stack.pop() should equal (2)

Otherwise, if false, spaces before arguments will always be removed.

rewriteArrowSymbols

Default: false

Replace arrow tokens with their unicode equivalents: => with , and <- with . For example:

for (n <- 1 to 10) n % 2 match {
  case 0 => println("even")
  case 1 => println("odd")
}

is formatted as:

for (n ← 1 to 10) n % 2 match {
  case 0 ⇒ println("even")
  case 1 ⇒ println("odd")
}

spaceBeforeColon

Default: false

Whether to ensure a space before colon. For example, If false, then:

def add(a: Int, b: Int): Int = a + b

If true, then:

def add(a : Int, b : Int) : Int = a + b

Scala Style Guide

Scalariform is "compatible" with the Scala Style Guide v1.1.0 in the sense that, given the right preference settings, source code that is initially compiliant with the Style Guide will not become uncompliant after formatting. In a number of cases, running the formatter will make uncompliant source more compliant.

Preference Value Default?
alignParameters false  
compactStringConcatenation false  
doubleIndentClassDeclaration true No
indentSpaces 2  
preserveSpaceBeforeArguments false  
rewriteArrowSymbols false  
spaceBeforeColon false  

Source directives

As well as global preferences, formatting can be tweaked at the source level through comments.

format: [ON|OFF]

Disables the formatter for selective portions of a source file:

// format: OFF    <-- this directive disables formatting from this point
class AsciiDSL {
  n ¦- "1" -+ { n: Node =>
          n ¦- "i"
          n ¦- "ii"
          n ¦- "iii"
          n ¦- "iv"
          n ¦- "v"
  }
  n ¦- "2"
  n ¦- "3" -+ { n: Node =>
          n ¦- "i"
          n ¦- "ii" -+ { n: Node =>
                   n ¦- "a"
                   n ¦- "b"
                   n ¦- "c"
          }
          n ¦- "iii"
          n ¦- "iv"
          n ¦- "v"
  }
  // format: ON   <-- formatter resumes from this point
  ...
}
// (see: http://dev.day.com/microsling/content/blogs/main/scalajcr2.html)

format: [+|-]<preferenceName>

Sets a preference for the entire of the source file, overriding the global formatting settings:

// format: +preserveSpaceBeforeArguments
class StackSpec extends FlatSpec with ShouldMatchers {
  // ...
  stack.pop() should equal (2)
}
Jump to Line
Something went wrong with that request. Please try again.