Merge pull request #244 from godenji/0.2.1

0.2.1 release

Author: godenji

CHANGELOG

@@ -1,3 +1,28 @@
+0.2.0 (11/July/17)
+
+* Added alignArguments
+* Added compactControlReadability
+* Added doubleIndentConstructorArguments
+* Added doubleIndentMethodDeclaration
+* Added firstArgumentOnNewline
+* Added firstParameterOnNewline
+* Added indentWithTabs
+* Added multilineScaladocCommentsStartOnFirstLine
+* Added newlineAtEndOfFile
+* Added placeScaladocAsterisksBeneathSecondAsterisk
+* Added spaceBeforeContextColon
+* Added lexer support for string extractors with wildcards (#144)
+* Added support for Scala 2.12
+* Added support for ScalaTest 3.0
+* FIX: multi-line indentation in more than call and match expressions (#143)
+* FIX: line-wrapping of class parameters when using DoubleIndentClassDeclaration (#187)
+* FIX: comment formatter to retain blank lines in multiline comments (#208)
+* Default danglingCloseParenthesis to Prevent (#200)
+* Default spacesAroundMultiImports to true (#198)
+* Remove RARROW TokenType (#210)
+* Deprecated PreserveDanglingCloseParenthesis replaced with DanglingCloseParenthesis
+* Deprecated DoubleIndentClassDeclaration replaced with DoubleIndentConstructorArguments
+
 0.1.8 (7/December/15)
 * FIX: broken indentation in multiline argument lists. (issue #85)
 * Added backwards compatible dangling parenthesis via DanglingCloseParenthesis (issue #79, #29)

README.rst

@@ -1,20 +1,28 @@
-#Scalariform formatter preferences
-#Fri Apr 01 21:09:37 BST 2011
+#alignArguments=false
 alignParameters=true
-compactStringConcatenation=false
-indentPackageBlocks=true
-formatXml=true
-preserveSpaceBeforeArguments=false
-doubleIndentConstructorArguments=false
-doubleIndentMethodDeclaration=false
-rewriteArrowSymbols=false
 alignSingleLineCaseStatements=true
-alignSingleLineCaseStatements.maxArrowIndent=40
-spaceBeforeColon=false
-spaceInsideBrackets=false
-spaceInsideParentheses=false
-preserveDanglingCloseParenthesis=false
-indentSpaces=2
-indentLocalDefs=false
-spacesWithinPatternBinders=true
-spacesAroundMultiImports=true
+#alignSingleLineCaseStatements.maxArrowIndent=40
+#compactControlReadability=false
+#compactStringConcatenation=false
+danglingCloseParenthesis=Force
+#doubleIndentClassDeclaration=false
+#doubleIndentConstructorArguments=false
+#doubleIndentMethodDeclaration=false
+#firstArgumentOnNewline=Force
+#firstParameterOnNewline=Force
+#formatXml=true
+#indentLocalDefs=false
+#indentPackageBlocks=true
+#indentSpaces=2
+#indentWithTabs=false
+#multilineScaladocCommentsStartOnFirstLine=false
+#newlineAtEndOfFile=false
+#placeScaladocAsterisksBeneathSecondAsterisk=false
+#preserveSpaceBeforeArguments=false
+#rewriteArrowSymbols=false
+#spaceBeforeColon=false
+#spaceBeforeContextColon=false
+#spaceInsideBrackets=false
+#spaceInsideParentheses=false
+#spacesAroundMultiImports=true
+#spacesWithinPatternBinders=true

formatterPreferences.properties

@@ -21,7 +21,16 @@ trait HasHiddenTokenInfo {
   def newlineBefore(node: AstNode): Boolean = newlineBefore(node.firstToken)
 }
 
-abstract class ScalaFormatter extends HasFormattingPreferences with TypeFormatter with AnnotationFormatter with ExprFormatter with HasHiddenTokenInfo with TemplateFormatter with XmlFormatter with CaseClauseFormatter with CommentFormatter {
+abstract class ScalaFormatter
+  extends HasFormattingPreferences
+  with TypeFormatter
+  with AnnotationFormatter
+  with ExprFormatter
+  with HasHiddenTokenInfo
+  with TemplateFormatter
+  with XmlFormatter
+  with CaseClauseFormatter
+  with CommentFormatter {
 
   val newlineSequence: String
 
@@ -82,10 +91,23 @@ abstract class ScalaFormatter extends HasFormattingPreferences with TypeFormatte
     var suspendFormatting = false
     var edits: List[TextEdit] = Nil // Stored in reverse
 
-    def printableFormattingInstruction(previousTokenOpt: Option[Token], token: Token) =
-      predecessorFormatting.get(token) orElse
-        previousTokenOpt.map(defaultFormattingInstruction(_, token)) getOrElse
-        (if (token.tokenType == EOF) EnsureNewlineAndIndent(0) /* <-- to allow formatting of files with just a scaladoc comment */ else Compact)
+    def printableFormattingInstruction(previousTokenOpt: Option[Token], token: Token) = {
+      val isGaplessAssignment =
+        predecessorFormatting.get(token) match { // avoid `foreach(_.id= ...)` gapless assignment (see MutateTest.scala)
+          case Some(PlaceAtColumn(_, _, Some(Token(USCORE, _, _, _)))) if token.tokenType == EQUALS => true
+          case _ => false
+        }
+      val maybeInstruction =
+        if (isGaplessAssignment) Some(CompactEnsuringGap)
+        else
+          predecessorFormatting.get(token).orElse(
+            previousTokenOpt.map(defaultFormattingInstruction(_, token))
+          )
+      maybeInstruction.getOrElse(
+        if (token.tokenType == EOF) EnsureNewlineAndIndent(0) /* <-- to allow formatting of files with just a scaladoc comment */
+        else Compact
+      )
+    }
 
     for ((previousTokenOption, token, nextTokenOption) ← Utils.withPreviousAndNext(tokens)) {
       val previousTokenIsPrintable = previousTokenOption exists { !isInferredNewline(_) }

scalariform/src/main/scala/scalariform/formatter/ScalaFormatter.scala

@@ -39,6 +39,7 @@ trait TemplateFormatter { self: HasFormattingPreferences with AnnotationFormatte
     }
     for (TemplateInheritanceSection(extendsOrSubtype, earlyDefsOpt, templateParentsOpt) ← templateInheritanceSectionOpt) {
       val doubleIndentTemplateInheritance = !formattingPreferences(DoubleIndentConstructorArguments) &&
+        formattingPreferences(DoubleIndentClassDeclaration) &&
         (templateBodyOption.exists(containsNewline(_)) || paramClausesOpt.exists(containsNewline(_)))
       val inheritanceIndent = if (doubleIndentTemplateInheritance) 2 else 1
       var currentFormatterState = formatterState

scalariform/src/main/scala/scalariform/formatter/TemplateFormatter.scala

@@ -90,13 +90,12 @@ trait IntegerPreferenceDescriptor extends PreferenceDescriptor[Int] {
 
 object AllPreferences {
   val preferences: List[PreferenceDescriptor[_]] = List(
-    RewriteArrowSymbols, IndentSpaces, SpaceBeforeColon, SpaceBeforeContextColon, CompactStringConcatenation,
-    PreserveSpaceBeforeArguments, AlignParameters, FirstParameterOnNewline, AlignArguments, FirstArgumentOnNewline,
-    DoubleIndentConstructorArguments, FormatXml, IndentPackageBlocks, AlignSingleLineCaseStatements,
-    AlignSingleLineCaseStatements.MaxArrowIndent, IndentLocalDefs, DanglingCloseParenthesis,
-    SpaceInsideParentheses, SpaceInsideBrackets, SpacesWithinPatternBinders, MultilineScaladocCommentsStartOnFirstLine, IndentWithTabs,
-    CompactControlReadability, PlaceScaladocAsterisksBeneathSecondAsterisk, DoubleIndentMethodDeclaration, SpacesAroundMultiImports,
-    NewlineAtEndOfFile
+    AlignArguments, AlignParameters, AlignSingleLineCaseStatements, AlignSingleLineCaseStatements.MaxArrowIndent,
+    CompactControlReadability, CompactStringConcatenation, DanglingCloseParenthesis, DoubleIndentClassDeclaration,
+    DoubleIndentConstructorArguments, DoubleIndentMethodDeclaration, FirstArgumentOnNewline, FirstParameterOnNewline,
+    FormatXml, IndentLocalDefs, IndentPackageBlocks, IndentSpaces, IndentWithTabs, MultilineScaladocCommentsStartOnFirstLine,
+    NewlineAtEndOfFile, PlaceScaladocAsterisksBeneathSecondAsterisk, PreserveSpaceBeforeArguments, RewriteArrowSymbols,
+    SpaceBeforeColon, SpaceBeforeContextColon, SpaceInsideBrackets, SpaceInsideParentheses, SpacesAroundMultiImports, SpacesWithinPatternBinders
   )
 
   val preferencesByKey: Map[String, PreferenceDescriptor[_]] =
@@ -105,28 +104,34 @@ object AllPreferences {
     }
 }
 
-case object RewriteArrowSymbols extends BooleanPreferenceDescriptor {
-  val key = "rewriteArrowSymbols"
-  val description = "Replace arrow tokens with unicode equivalents: => with ⇒, and <- with ←"
+case object AlignArguments extends BooleanPreferenceDescriptor {
+  val key = "alignArguments"
+  val description = "Align method arguments on different lines in the same column"
   val defaultValue = false
 }
 
-case object IndentSpaces extends IntegerPreferenceDescriptor {
-  val key = "indentSpaces"
-  val description = "Number of spaces to use for indentation"
-  val preferenceType = IntegerPreference(1, 10)
-  val defaultValue = 2
+case object AlignParameters extends BooleanPreferenceDescriptor {
+  val key = "alignParameters"
+  val description = "Align parameters on different lines in the same column"
+  val defaultValue = false
 }
 
-case object SpaceBeforeColon extends BooleanPreferenceDescriptor {
-  val key = "spaceBeforeColon"
-  val description = "Add a space before colons"
+case object AlignSingleLineCaseStatements extends BooleanPreferenceDescriptor {
+  val key = "alignSingleLineCaseStatements"
+  val description = "Align the arrows of consecutive single-line case statements"
   val defaultValue = false
+
+  case object MaxArrowIndent extends IntegerPreferenceDescriptor {
+    val key = "alignSingleLineCaseStatements.maxArrowIndent"
+    val description = "Maximum number of spaces inserted before an arrow to align case statements"
+    val preferenceType = IntegerPreference(1, 100)
+    val defaultValue = 40
+  }
 }
 
-case object SpaceBeforeContextColon extends BooleanPreferenceDescriptor {
-  val key = "spaceBeforeContextColon"
-  val description = "Add a space before colons in context bounds"
+case object CompactControlReadability extends BooleanPreferenceDescriptor {
+  val key = "compactControlReadability"
+  val description = "Enable Compact Control Readability style"
   val defaultValue = false
 }
 
@@ -136,27 +141,28 @@ case object CompactStringConcatenation extends BooleanPreferenceDescriptor {
   val defaultValue = false
 }
 
-case object PreserveSpaceBeforeArguments extends BooleanPreferenceDescriptor {
-  val key = "preserveSpaceBeforeArguments"
-  val description = "Preserve a space before a parenthesis argument"
-  val defaultValue = false
+case object DanglingCloseParenthesis extends IntentPreferenceDescriptor {
+  val key = "danglingCloseParenthesis"
+  val description = "Put a newline before a ')' in an argument expression"
+  val defaultValue = Prevent
 }
 
-case object AlignParameters extends BooleanPreferenceDescriptor {
-  val key = "alignParameters"
-  val description = "Align parameters on different lines in the same column"
+case object DoubleIndentConstructorArguments extends BooleanPreferenceDescriptor {
+  val key = "doubleIndentConstructorArguments"
+  val description = "Class (and trait / object) declarations will be formatted as recommended by the Scala Style Guide"
   val defaultValue = false
 }
 
-case object FirstParameterOnNewline extends IntentPreferenceDescriptor {
-  val key = "firstParameterOnNewline"
-  val description = "Places the first parameter in function or class definitions on a new line"
-  val defaultValue = Force
+@deprecated("This has been dropped in favor of DoubleIndentConstructorArguments.", since = "0.2.0")
+case object DoubleIndentClassDeclaration extends BooleanPreferenceDescriptor {
+  val key = "doubleIndentClassDeclaration"
+  val description = "Double indent a class's inheritance list (only applies when DoubleIndentConstructorArguments is set to false)"
+  val defaultValue = false
 }
 
-case object AlignArguments extends BooleanPreferenceDescriptor {
-  val key = "alignArguments"
-  val description = "Align method arguments on different lines in the same column"
+case object DoubleIndentMethodDeclaration extends BooleanPreferenceDescriptor {
+  val key = "doubleIndentMethodDeclaration"
+  val description = "Double indent a method's parameters, if they span multiple lines"
   val defaultValue = false
 }
 
@@ -166,16 +172,10 @@ case object FirstArgumentOnNewline extends IntentPreferenceDescriptor {
   val defaultValue = Force
 }
 
-case object DoubleIndentConstructorArguments extends BooleanPreferenceDescriptor {
-  val key = "doubleIndentConstructorArguments"
-  val description = "Class (and trait / object) declarations will be formatted as recommended by the Scala Style Guide"
-  val defaultValue = false
-}
-
-case object DoubleIndentMethodDeclaration extends BooleanPreferenceDescriptor {
-  val key = "doubleIndentMethodDeclaration"
-  val description = "Double indent a method's parameters, if they span multiple lines"
-  val defaultValue = false
+case object FirstParameterOnNewline extends IntentPreferenceDescriptor {
+  val key = "firstParameterOnNewline"
+  val description = "Places the first parameter in function or class definitions on a new line"
+  val defaultValue = Force
 }
 
 case object FormatXml extends BooleanPreferenceDescriptor {
@@ -184,77 +184,82 @@ case object FormatXml extends BooleanPreferenceDescriptor {
   val defaultValue = true
 }
 
+case object IndentLocalDefs extends BooleanPreferenceDescriptor {
+  val key = "indentLocalDefs"
+  val description = "Indent local defs an extra level"
+  val defaultValue = false
+}
+
 case object IndentPackageBlocks extends BooleanPreferenceDescriptor {
   val key = "indentPackageBlocks"
   val description = "Indent package blocks"
   val defaultValue = true
 }
 
-case object AlignSingleLineCaseStatements extends BooleanPreferenceDescriptor {
-  val key = "alignSingleLineCaseStatements"
-  val description = "Align the arrows of consecutive single-line case statements"
-  val defaultValue = false
-
-  case object MaxArrowIndent extends IntegerPreferenceDescriptor {
-    val key = "alignSingleLineCaseStatements.maxArrowIndent"
-    val description = "Maximum number of spaces inserted before an arrow to align case statements"
-    val preferenceType = IntegerPreference(1, 100)
-    val defaultValue = 40
-  }
+case object IndentSpaces extends IntegerPreferenceDescriptor {
+  val key = "indentSpaces"
+  val description = "Number of spaces to use for indentation"
+  val preferenceType = IntegerPreference(1, 10)
+  val defaultValue = 2
+}
 
+case object IndentWithTabs extends BooleanPreferenceDescriptor {
+  val key = "indentWithTabs"
+  val description = "Use a tab character for indentation"
+  val defaultValue = false
 }
 
-case object IndentLocalDefs extends BooleanPreferenceDescriptor {
-  val key = "indentLocalDefs"
-  val description = "Indent local defs an extra level"
+case object MultilineScaladocCommentsStartOnFirstLine extends BooleanPreferenceDescriptor {
+  val key = "multilineScaladocCommentsStartOnFirstLine"
+  val description = "Start multiline Scaladoc comment body on same line as the opening '/**' "
   val defaultValue = false
 }
 
-case object DanglingCloseParenthesis extends IntentPreferenceDescriptor {
-  val key = "danglingCloseParenthesis"
-  val description = "Put a newline before a ')' in an argument expression"
-  val defaultValue = Prevent
+case object NewlineAtEndOfFile extends BooleanPreferenceDescriptor {
+  val key = "newlineAtEndOfFile"
+  val description = "Add a newline at the end of all files"
+  val defaultValue = false
 }
 
-case object SpaceInsideParentheses extends BooleanPreferenceDescriptor {
-  val key = "spaceInsideParentheses"
-  val description = "Require a space after '(' and before ')'"
+case object PlaceScaladocAsterisksBeneathSecondAsterisk extends BooleanPreferenceDescriptor {
+  val key = "placeScaladocAsterisksBeneathSecondAsterisk"
+  val description = "Place Scaladoc asterisks beneath the second asterisk in the opening '/**', as opposed to the first"
   val defaultValue = false
 }
 
-case object SpaceInsideBrackets extends BooleanPreferenceDescriptor {
-  val key = "spaceInsideBrackets"
-  val description = "Require a space after '[' and before ']'"
+case object PreserveSpaceBeforeArguments extends BooleanPreferenceDescriptor {
+  val key = "preserveSpaceBeforeArguments"
+  val description = "Preserve a space before a parenthesis argument"
   val defaultValue = false
 }
 
-case object SpacesWithinPatternBinders extends BooleanPreferenceDescriptor {
-  val key = "spacesWithinPatternBinders"
-  val description = "Add a space around the @ token in pattern binders"
-  val defaultValue = true
+case object RewriteArrowSymbols extends BooleanPreferenceDescriptor {
+  val key = "rewriteArrowSymbols"
+  val description = "Replace arrow tokens with unicode equivalents: => with ⇒, and <- with ←"
+  val defaultValue = false
 }
 
-case object MultilineScaladocCommentsStartOnFirstLine extends BooleanPreferenceDescriptor {
-  val key = "multilineScaladocCommentsStartOnFirstLine"
-  val description = "Start multiline Scaladoc comment body on same line as the opening '/**' "
+case object SpaceBeforeColon extends BooleanPreferenceDescriptor {
+  val key = "spaceBeforeColon"
+  val description = "Add a space before colons"
   val defaultValue = false
 }
 
-case object IndentWithTabs extends BooleanPreferenceDescriptor {
-  val key = "indentWithTabs"
-  val description = "Use a tab character for indentation"
+case object SpaceBeforeContextColon extends BooleanPreferenceDescriptor {
+  val key = "spaceBeforeContextColon"
+  val description = "Add a space before colons in context bounds"
   val defaultValue = false
 }
 
-case object CompactControlReadability extends BooleanPreferenceDescriptor {
-  val key = "compactControlReadability"
-  val description = "Enable Compact Control Readability style"
+case object SpaceInsideBrackets extends BooleanPreferenceDescriptor {
+  val key = "spaceInsideBrackets"
+  val description = "Require a space after '[' and before ']'"
   val defaultValue = false
 }
 
-case object PlaceScaladocAsterisksBeneathSecondAsterisk extends BooleanPreferenceDescriptor {
-  val key = "placeScaladocAsterisksBeneathSecondAsterisk"
-  val description = "Place Scaladoc asterisks beneath the second asterisk in the opening '/**', as opposed to the first"
+case object SpaceInsideParentheses extends BooleanPreferenceDescriptor {
+  val key = "spaceInsideParentheses"
+  val description = "Require a space after '(' and before ')'"
   val defaultValue = false
 }
 
@@ -264,8 +269,8 @@ case object SpacesAroundMultiImports extends BooleanPreferenceDescriptor {
   val defaultValue = true
 }
 
-case object NewlineAtEndOfFile extends BooleanPreferenceDescriptor {
-  val key = "newlineAtEndOfFile"
-  val description = "Add a newline at the end of all files"
-  val defaultValue = false
+case object SpacesWithinPatternBinders extends BooleanPreferenceDescriptor {
+  val key = "spacesWithinPatternBinders"
+  val description = "Add a space around the @ token in pattern binders"
+  val defaultValue = true
 }

scalariform/src/main/scala/scalariform/formatter/preferences/PreferenceDescriptor.scala

@@ -0,0 +1,34 @@
+package scalariform.formatter
+
+import scalariform.parser._
+
+// format: OFF
+class MutateTest extends AbstractFormatterTest {
+
+  // avoid gapless assignment
+
+  """object Test {
+    |  htmlNodeList.foreach(_.outerHTML=block.toString)
+    |}""" ==>
+  """object Test {
+    |  htmlNodeList.foreach(_.outerHTML = block.toString)
+    |}"""
+
+  """object Test {
+    |  maybeHtmlNode.foreach(_.outerHTML= block.toString)
+    |}""" ==>
+  """object Test {
+    |  maybeHtmlNode.foreach(_.outerHTML = block.toString)
+    |}"""
+
+//  format: ON
+
+  override val debug = false
+
+  def parse(parser: ScalaParser) = parser.nonLocalDefOrDcl()
+
+  type Result = FullDefOrDcl
+
+  def format(formatter: ScalaFormatter, result: Result) = formatter.format(result)(FormatterState(indentLevel = 0))
+
+}

scalariform/src/test/scala/scalariform/formatter/MutateTest.scala

@@ -80,6 +80,21 @@ class ParenAndBracketSpacingTest extends AbstractExpressionFormatterTest {
       |  "bar",
       |  false
       |)"""
+
+    // TODO find out why parens based sub expressions do not dangle
+
+    """foo(
+      |alpha = "foo",
+      |beta = collection.map { x =>
+      |  x
+      |}
+      )""" ==>
+    """foo(
+      |  alpha = "foo",
+      |  beta = collection.map { x =>
+      |    x
+      |  }
+      |)"""
   }
 
   {

scalariform/src/test/scala/scalariform/formatter/ParenAndBracketSpacingTest.scala

@@ -600,7 +600,7 @@ implicit val formattingPreferences = FormattingPreferences.setPreference(SpacesW
     |})"""
 
   {
-    implicit val formattingPreferences = FormattingPreferences.setPreference(DoubleIndentConstructorArguments, true)
+    implicit val formattingPreferences = FormattingPreferences.setPreference(DoubleIndentClassDeclaration, true)
     """class Person(
       |  name: String,
       |  age: Int)
@@ -609,21 +609,21 @@ implicit val formattingPreferences = FormattingPreferences.setPreference(SpacesW
       |    with Identifiable
       |    with Serializable""" ==>
     """class Person(
-      |    name: String,
-      |    age: Int)
-      |  extends Entity
-      |  with Logging
-      |  with Identifiable
-      |  with Serializable"""
+      |  name: String,
+      |  age: Int)
+      |    extends Entity
+      |    with Logging
+      |    with Identifiable
+      |    with Serializable"""
 
     """class Person(
       |    name: String,
       |    age: Int) {
       |  def firstMethod = 42
       |}""" ==>
     """class Person(
-      |    name: String,
-      |    age: Int) {
+      |  name: String,
+      |  age: Int) {
       |  def firstMethod = 42
       |}"""
 
@@ -633,8 +633,8 @@ implicit val formattingPreferences = FormattingPreferences.setPreference(SpacesW
       |  def firstMethod = 42
       |}""" ==>
     """class Person(
-      |    name: String,
-      |    age: Int) {
+      |  name: String,
+      |  age: Int) {
       |  def firstMethod = 42
       |}"""
 
@@ -646,10 +646,10 @@ implicit val formattingPreferences = FormattingPreferences.setPreference(SpacesW
     |def firstMethod = 42
     |}""" ==>
   """class Person(name: String, age: Int, birthdate: Date, astrologicalSign: String, shoeSize: Int, favoriteColor: java.awt.Color)
-    |  extends Entity
-    |  with Logging
-    |  with Identifiable
-    |  with Serializable {
+    |    extends Entity
+    |    with Logging
+    |    with Identifiable
+    |    with Serializable {
     |  def firstMethod = 42
     |}"""
 
@@ -660,9 +660,9 @@ implicit val formattingPreferences = FormattingPreferences.setPreference(SpacesW
       |def method() = 42
       |}""" ==>
     """class Person(
-      |    name: String,
-      |    age: Int)
-      |  extends Entity {
+      |  name: String,
+      |  age: Int)
+      |    extends Entity {
       |  def method() = 42
       |}"""
 
@@ -672,8 +672,8 @@ implicit val formattingPreferences = FormattingPreferences.setPreference(SpacesW
     |println("d")
     |}""" ==>
   """trait A
-    |  extends B
-    |  with C {
+    |    extends B
+    |    with C {
     |  println("d")
     |}"""
 

scalariform/src/test/scala/scalariform/formatter/TemplateFormatterTest.scala

@@ -1 +1 @@
-version in ThisBuild := "0.2.0"
+version in ThisBuild := "0.2.1"