Merge pull request scalameta#725 from ysusuk/master

scalameta#724: Update rewrite rules docs
bjornj12 · Feb 9, 2017 · cd6c380 · cd6c380
2 parents beab26f + 1c66359
commit cd6c380
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 1 deletion.
diff --git a/readme/Configuration.scalatex b/readme/Configuration.scalatex
@@ -420,9 +420,52 @@
     Default: @b{[]}
 
     @p
-      @b{NEW}. Semantically preserving rewrites. To enable a
+      Semantically preserving rewrites. To enable a
       rewrite rule, add it to the config like this @b{rewrite.rules = [SortImports]}.
 
+    @sect(Rewrite.rewrite2name(AvoidInfix))
+      @demoStyle(rewriteInfix)
+        future recover {
+          case e: ArithmeticException ⇒ 0
+        } map (_.toString)
+    Configuration contains include/exclude operator filters (those values are build in, and can't be configured outside)
+    @ul
+      @li
+        Default include filter matches on alpha-num operator name (means that rewrite will be applied, if it's not excluded).
+      @li
+        Default exclude filter matches on (means that rewrite won't be applied):
+          "until",
+          "to",
+          "by",
+          "eq",
+          "ne",
+          "should.*",
+          "contain.*",
+          "must.*",
+          "in",
+          "be",
+          "taggedAs",
+          "thrownBy",
+          "synchronized",
+          "have",
+          "when".
+
+    @sect(Rewrite.rewrite2name(ExpandImportSelectors))
+      @demoStyle(rewriteImportSelectors)
+        import a.{
+            b,
+            c
+          }, h.{
+            k, l
+          }
+          import d.e.{f, g}
+          import a.{
+              foo => bar,
+              zzzz => _,
+              _
+            }
+
+
     @sect(Rewrite.rewrite2name(RedundantBraces))
       @demoStyle(rewriteBraces)
         object RedundantBraces {

diff --git a/readme/src/main/scala/org/scalafmt/readme/Readme.scala b/readme/src/main/scala/org/scalafmt/readme/Readme.scala
@@ -113,6 +113,18 @@ object Readme {
   val stripMarginStyle =
     ScalafmtConfig.default.copy(assumeStandardLibraryStripMargin = true)
 
+  val rewriteInfix =
+    ScalafmtConfig.default.copy(
+      rewrite = ScalafmtConfig.default.rewrite.copy(
+        rules = Seq(AvoidInfix)
+      ))
+
+  val rewriteImportSelectors =
+    ScalafmtConfig.default.copy(
+      rewrite = ScalafmtConfig.default.rewrite.copy(
+        rules = Seq(ExpandImportSelectors)
+      ))
+
   val rewriteBraces =
     ScalafmtConfig.default.copy(
       rewrite = ScalafmtConfig.default.rewrite.copy(