Merge pull request #195 from olafurpg/docs

Update docs and add 0.4.1 changelog.

Author: olafurpg

readme/Changelog04.scalatex

@@ -2,6 +2,34 @@
 @import scalafix.Readme._
 @import scalafix.Versions
 
+@sect{0.4.1}
+  First of all, I'd like to welcome Gabriele Petronella, @user{gabro}, to the
+  @lnk("scalafix team", "https://github.com/scalacenter/scalafix#team")! See @pr(184).
+
+  @ul
+    @li
+      New rewrite @sect.ref{NoExtendsApp}, by @user{gabro}.
+    @li
+      New rewrite @sect.ref{DottyVarArgPattern}, by @user{gosubpl}.
+    @li
+      Errors in the @sect.ref{scalafix-testkit} docs have now been fixed, by @user{taisukeoe}.
+    @li
+      @code{--sourceroot} is now used by scalafix-cli, @issue(176).
+    @li
+      @code{--sourcepath} is no longer used by scalafix-cli.
+    @li
+      @sect.ref{NoAutoTupling} now handles Function1 signatures,
+      see @issue(147).
+    @li
+      scalafix-cli now supports @code{--include} and @code{--exclude}
+      to filter which files get fixed. See @sect.ref{--help} for more details.
+    @li
+      @sect.ref{RemoveUnusedImports} now also removes unused renamed imports,
+      see @issue(189).
+
+  Big thanks you everybody who contributed this release via issues, pull requests,
+  online discussions on @gitter and and offline discussions at Scaladays Copenhagen last week!
+
 @sect{0.4.0}
   @p
     This release represents a significant milestone for Scalafix.

readme/Installation.scalatex

@@ -76,8 +76,9 @@
       ./scalafix --help
 
     @p
-      Once the scalafix cli is installed, consult the help page for further usage
+      Once the scalafix cli is installed, consult the --help page for further usage
       instructions
 
+  @sect{--help}
     @hl.scala(Cli.helpMessage)
 

readme/Rewrites.scalatex

@@ -41,9 +41,30 @@
     See @lnk("slick/slick/pulls#1736", "https://github.com/slick/slick/pull/1736")
     for an example diff from running @code{sbt "scalafix RemoveUnusedImports"}.
 
+    @p
+      To use this rewrite:
+      @ul
+        @li
+          enable @code{-Ywarn-unused-import}
+        @li
+          disable @code{-Xfatal-warnings}. Unfortunately, the Scala compiler
+          does not support finer grained control over the severity level
+          per message kind. See @metaIssue(924) for a possible workaround
+          in the near future.
+
+    @hl.scala
+      // before
+      import scala.List
+      import scala.collection.{immutable, mutable}
+      object Foo { immutable.Seq.empty[Int] }
+
+      // before
+      import scala.collection.immutable
+      object Foo { immutable.Seq.empty[Int] }
+
     @p
       @note. This rewrite does a best-effort at preserving original formatting.
-      In some cases, the rewriten code may be formatted weirdly
+      In some cases, the rewritten code may be formatted weirdly
 
       @hl.scala
         // before
@@ -56,12 +77,7 @@
 
           TimeoutException
 
-      It's recommended to use a code formatter to clean up missing or superfluous
-      whitespace.
-
-    @p
-      @note. This rewrite is new and has only been tested on a few large projects
-      such as Slick and Scalding. Please report if you hit on buggy behavior.
+      It's recommended to use a code formatter after running this rewrite.
 
   @sect(RemoveXmlLiterals.toString)
     This rewrites replaces XML literals with a @code{xml""} interpolator

readme/src/main/scala/scalafix/Readme.scala

@@ -19,8 +19,10 @@ object Readme {
 
   def github: String = "https://github.com"
   def repo: String = "https://github.com/scalacenter/scalafix"
+  def metaRepo: String = "https://github.com/scalameta/scalameta"
   def user(name: String): Frag = a(href := s"$github/$name", s"@$name")
   def issue(i: Int): Frag = a(href := s"$repo/issues/$i", s"#$i")
+  def metaIssue(i: Int): Frag = a(href := s"$metaRepo/issues/$i", s"#$i")
   def pr(i: Int): Frag = a(href := s"$repo/pulls/$i", s"#$i")
   def dotty = a(href := "http://dotty.epfl.ch/", "Dotty")
   def comment(frags: Frag*): TypedTag[String] = span("")

scalafix-cli/src/main/scala/scalafix/cli/CliRunner.scala

@@ -127,7 +127,6 @@ object CliRunner {
     for {
       database <- builder.resolvedMirror
       sourceroot <- builder.resolvedSourceroot
-      _ <- builder.assertSourcepathIsEmpty
       rewrite <- builder.resolvedRewrite
       replace <- builder.resolvedPathReplace
       inputs <- builder.resolvedInputs
@@ -165,9 +164,6 @@ object CliRunner {
 
     implicit val workingDirectory: AbsolutePath = common.workingPath
 
-    val assertSourcepathIsEmpty: Configured[Unit] =
-      cli.sourcepath.fold(Configured.unit)(path =>
-        ConfError.msg(s"Expected --sourcepath to be empty, was $path.").notOk)
     // Database
     private val resolvedDatabase: Configured[Database] =
       (classpath, sourceroot) match {

scalafix-cli/src/main/scala/scalafix/cli/ScalafixOptions.scala

@@ -61,12 +61,6 @@ case class ScalafixOptions(
     )
     @ValueDescription("entry1.jar:entry2.jar")
     classpath: Option[String] = None,
-    @Hidden // TODO(olafur) remove in v0.4. This is not used.
-    @HelpMessage(
-      """java.io.File.pathSeparator separated list of Scala source files OR
-        |        directories containing Scala source files""".stripMargin)
-    @ValueDescription("File2.scala:File1.scala:src/main/scala")
-    sourcepath: Option[String] = None,
     @HelpMessage(
       s"""Rewrite rules to run.
          |        NOTE. rewrite.rules = [ .. ] from --config will also run""".stripMargin

scalafix-sbt/src/main/scala/scalafix/sbt/ScalafixPlugin.scala

@@ -37,7 +37,7 @@ object ScalafixPlugin extends AutoPlugin {
         publishArtifact := false,
         publishMavenStyle := false, // necessary to support intransitive dependencies.
         scalaVersion := Versions.scala212,
-//        libraryDependencies := Nil, // remove injected dependencies from random sbt plugins.
+        libraryDependencies := Nil, // remove injected dependencies from random sbt plugins.
         libraryDependencies +=
           "ch.epfl.scala" % "scalafix-cli" % scalafixVersion cross CrossVersion.full
       )
@@ -48,8 +48,8 @@ object ScalafixPlugin extends AutoPlugin {
     cliWrapperClasspath := {
       CrossVersion.partialVersion(sbtVersion.value) match {
         case Some((0, x)) if x < 13 =>
-          streams.value.log
-            .warn("sbt-scalafix requires sbt 0.13.13 or higher.")
+          throw new MessageOnlyException(
+            "sbt-scalafix requires sbt 0.13.13 or higher.")
         case _ =>
       }
       managedClasspath.in(scalafixStub, Compile).value