Add flag to skip insertion of spaces within multi imports (rebase)

CHANGELOG

@@ -1,8 +1,16 @@
+0.1.5 (..)
+* FIX: Type formatter crash on multiline types
+* Track scalac parser -- allow trait-position parents to have parameter blocks
+* Sync changes to InferredSemicolonParser
+
+0.1.4 (24/April/13)
+* FIX: Allow declarations as last statement in case block (issue #60)
+* Update to build 2.10 final
+
 0.1.3 (3/October/12)
 * Add EOF to ComplilationUnit, ensuring entire source is represented in the tree
 * Support $this references in String interpolation
 * Update build to sbt 0.12.1
-* FIX: Allow declarations as last statement in case block (issue #60).
 
 0.1.2 (7/May/12)
 

README.rst

@@ -28,6 +28,31 @@ You can also configure formatting to be run as a save action (Window -> Preferen
 
 To set preferences, go to Window -> Preferences -> Scala -> Formatter
 
+Integration with IntelliJ
+-------------------------
+
+IntelliJ already has a built-in Scala code formatter (C-L).
+I use the original settings plus `Wraping and Braces` -> `Align columns in case branches`.
+In order to achieve exactly the same formatting use the following options::
+
+
+  def formattingPreferences = {
+    import scalariform.formatter.preferences._
+    FormattingPreferences()
+        .setPreference(AlignParameters, true)
+        .setPreference(AlignSingleLineCaseStatements, true)
+        .setPreference(AlignSingleLineCaseStatements.AlignMultiLineCaseStatements, true)
+        .setPreference(AlignSingleLineCaseStatements.MaxArrowIndent, 120)
+        .setPreference(AlignSingleLineCaseStatements.GroupByNewLine, true) // IntelliJ compatible
+        .setPreference(CompactControlReadability, false)
+        .setPreference(NoSpacesAroundMultiImports, true)
+        .setPreference(FormatXml, false)
+        .setPreference(PreserveSpaceBeforeArguments, true)
+        .setPreference(IndentWithTabs, false)
+        .setPreference(SpacesWithinPatternBinders, false) // IntelliJ compatible
+  }
+
+
 Integration with Emacs/ENSIME
 -----------------------------
 
@@ -59,7 +84,7 @@ Usage::
   <plugin>
     <groupId>org.scalariform</groupId>
     <artifactId>scalariform-maven-plugin</artifactId>
-    <version>0.1.3</version>
+    <version>0.1.4</version>
     <executions>
       <execution>
         <phase>process-sources</phase>
@@ -103,7 +128,7 @@ the following to ``.vimrc`` ::
 
 The executable scalariform.jar can be downloaded from:
 
-  https://github.com/downloads/mdr/scalariform/scalariform.jar
+  https://s3.amazonaws.com/scalariform/scalariform.jar
 
 Command line tool
 -----------------
@@ -474,6 +499,22 @@ If ``false``,::
 
   case elem@Multi(values@_*) =>
 
+chainedPackageClauses
+~~~~~~~~~~~~~~~~~~~~~
+
+Default: ``false``
+
+Example::
+```
+  package com.company.analytics.math.curves.interpolators
+```
+
+Will be reformatted to::
+```
+  package com.company.analytics.math
+  package curves
+  package interpolators
+```
 
 Scala Style Guide
 ~~~~~~~~~~~~~~~~~

cli/.classpath

@@ -1,12 +1,11 @@
-<?xml version="1.0" encoding="UTF-8"?>
 <classpath>
-	<classpathentry kind="src" output="bin" path="src/main/scala"/>
-	<classpathentry kind="src" output="bin" path="src/main/java"/>
-	<classpathentry kind="src" output="bin" path="src/test/scala"/>
-	<classpathentry kind="src" output="bin" path="src/test/java"/>
-	<classpathentry kind="con" path="org.scala-ide.sdt.launching.SCALA_CONTAINER"/>
-	<classpathentry kind="lib" path="../lib_managed/jars/commons-io/commons-io/commons-io-1.4.jar" sourcepath="/lib_managed/srcs/commons-io/commons-io/commons-io-1.4-sources.jar"/>
-	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
-	<classpathentry combineaccessrules="false" kind="src" path="/scalariform"/>
-	<classpathentry kind="output" path="bin"/>
-</classpath>
+  <classpathentry output="bin" path="src/main/scala" kind="src"></classpathentry>
+  <classpathentry output="bin" path="src/main/java" kind="src"></classpathentry>
+  <classpathentry output="bin" path="src/test/scala" kind="src"></classpathentry>
+  <classpathentry output="bin" path="src/test/java" kind="src"></classpathentry>
+  <classpathentry kind="con" path="org.scala-ide.sdt.launching.SCALA_CONTAINER"></classpathentry>
+  <classpathentry kind="lib" path="../lib_managed/jars/commons-io/commons-io/commons-io-1.4.jar" sourcepath="../lib_managed/srcs/commons-io/commons-io/commons-io-1.4-sources.jar"></classpathentry>
+  <classpathentry exported="true" path="/scalariform" kind="src" combineaccessrules="false"></classpathentry>
+  <classpathentry path="org.eclipse.jdt.launching.JRE_CONTAINER" kind="con"></classpathentry>
+  <classpathentry path="bin" kind="output"></classpathentry>
+</classpath>

cli/src/main/scala/scalariform/commandline/Main.scala

@@ -254,26 +254,11 @@ object Main {
 
   private def transformFilesInPlace(files: Seq[File], encoding: String, doFormat: String ⇒ Option[String], log: String ⇒ Unit): Boolean = {
     var problems = false
-    //    val futures =
-    //      for (file ← files) yield asyncExec {
-    //        problems &= transformFileInPlace(file, encoding, doFormat, log)
-    //      }
-    //    futures.map(_.get())
     for (file ← files)
       problems &= transformFileInPlace(file, encoding, doFormat, log)
     problems
   }
 
-  //  private val lock = new ReentrantLock
-  //  private lazy val executorService = Executors.newCachedThreadPool()
-  //  private def asyncExec(x: ⇒ Unit): Future[_] = executorService.submit(new Runnable { def run() = x })
-  //  private def withLock[T](x: ⇒ T): T = {
-  //    lock.lock()
-  //    try
-  //      x
-  //    finally
-  //      lock.unlock()
-  //  }
   /**
    * @return true iff file is already formatted correctly
    */

docs/source/conf.py

@@ -45,9 +45,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.1.4-SNAPSHOT'
+version = '0.1.5-SNAPSHOT'
 # The full version, including alpha/beta/rc tags.
-release = '0.1.4-SNAPSHOT'
+release = '0.1.5-SNAPSHOT'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

misc/.classpath

@@ -1,14 +1,13 @@
-<?xml version="1.0" encoding="UTF-8"?>
 <classpath>
-	<classpathentry kind="src" output="bin" path="src/main/scala"/>
-	<classpathentry kind="src" output="bin" path="src/main/java"/>
-	<classpathentry kind="src" output="bin" path="src/test/scala"/>
-	<classpathentry kind="src" output="bin" path="src/test/java"/>
-	<classpathentry kind="con" path="org.scala-ide.sdt.launching.SCALA_CONTAINER"/>
-	<classpathentry kind="lib" path="../lib_managed/jars/commons-io/commons-io/commons-io-1.4.jar" sourcepath="/lib_managed/srcs/commons-io/commons-io/commons-io-1.4-sources.jar"/>
-	<classpathentry kind="lib" path="../lib_managed/jars/com.miglayout/miglayout/miglayout-3.7.4.jar" sourcepath="/lib_managed/srcs/com.miglayout/miglayout/miglayout-3.7.4-sources.jar"/>
-	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
-	<classpathentry combineaccessrules="false" kind="src" path="/cli"/>
-	<classpathentry combineaccessrules="false" kind="src" path="/scalariform"/>
-	<classpathentry kind="output" path="bin"/>
-</classpath>
+  <classpathentry output="bin" path="src/main/scala" kind="src"></classpathentry>
+  <classpathentry output="bin" path="src/main/java" kind="src"></classpathentry>
+  <classpathentry output="bin" path="src/test/scala" kind="src"></classpathentry>
+  <classpathentry output="bin" path="src/test/java" kind="src"></classpathentry>
+  <classpathentry kind="con" path="org.scala-ide.sdt.launching.SCALA_CONTAINER"></classpathentry>
+  <classpathentry kind="lib" path="../lib_managed/jars/commons-io/commons-io/commons-io-1.4.jar" sourcepath="../lib_managed/srcs/commons-io/commons-io/commons-io-1.4-sources.jar"></classpathentry>
+  <classpathentry kind="lib" path="../lib_managed/jars/com.miglayout/miglayout/miglayout-3.7.4.jar" sourcepath="../lib_managed/srcs/com.miglayout/miglayout/miglayout-3.7.4-sources.jar"></classpathentry>
+  <classpathentry exported="true" path="/scalariform" kind="src" combineaccessrules="false"></classpathentry>
+  <classpathentry exported="true" path="/cli" kind="src" combineaccessrules="false"></classpathentry>
+  <classpathentry path="org.eclipse.jdt.launching.JRE_CONTAINER" kind="con"></classpathentry>
+  <classpathentry path="bin" kind="output"></classpathentry>
+</classpath>

misc/src/main/scala/scalariform/corpusscan/CorpusScanner.scala

@@ -1,16 +1,17 @@
 package scalariform.corpusscan
 
-import scalariform.lexer.{ Token ⇒ _, _ }
-import scalariform.formatter._
-import scalariform.formatter.preferences._
-import scalariform.parser._
-import scala.util.parsing.input._
-import scala.util.parsing.combinator._
 import java.io.File
+
 import scala.io.Source
-import scalariform.utils.Utils.writeText
+
 import org.apache.commons.io.FileUtils
+
 import scalariform.commandline.ScalaFileWalker
+import scalariform.formatter._
+import scalariform.formatter.preferences.FormattingPreferences
+import scalariform.lexer._
+import scalariform.parser._
+import scalariform.utils.Utils.writeText
 
 sealed trait ParseFault
 case object TokensDoNotCoverSource extends ParseFault
@@ -31,9 +32,9 @@ object CorpusScanner extends SpecificFormatter {
     val tokens = ScalaLexer.tokenise(source)
     try {
       val result = new ScalaParser(tokens.toArray).compilationUnitOrScript()
-      if (result.tokens != tokens.init) /* drop EOF */
+      if (result.tokens != tokens) {
         Some(BadAstTokens)
-      else
+      } else
         None
     } catch {
       case e: ScalaParserException ⇒ Some(UnsuccessfulParse)
@@ -66,9 +67,9 @@ object CorpusScanner extends SpecificFormatter {
 
 }
 
-object Runner {
+object Runner extends App {
 
-  val corpusDir = "/home/matt/coding/scala-corpus"
+  val corpusDir = "/home/matthew/coding/scala-corpus/repos2"
   //  val corpusDir = "/home/matt/scala-corpus"
 
   def checkParser() {
@@ -93,14 +94,14 @@ object Runner {
     for (file ← ScalaFileWalker.findScalaFiles(corpusDir)) {
       print("Formatting: " + file)
       CorpusScanner.formatFile(file)
-      val parsed = CorpusScanner.attemptToParse(file)
-      require(parsed == None, parsed.toString)
+      val parseFaultOpt = CorpusScanner.attemptToParse(file)
+      require(parseFaultOpt == None, parseFaultOpt.toString)
       println()
       count += 1
     }
     println(count + " files formatted.")
   }
 
-  def main(args: Array[String]) = formatInPlace()
+  formatInPlace()
 
 }