Merge pull request #26 from bjaglin/docs

fix & simplify instructions to run autofix for a one-time migration

3.0.x/README.md

@@ -1,46 +1,37 @@
 # Autofix for ScalaTest 3.0.x
-This scalafix application will rewrite your ScalaTest code to eliminate most of the deprecation warnings
+This scalafix rule will rewrite your ScalaTest code to eliminate most of the deprecation warnings
 introduced in ScalaTest 3.0.8. The deprecations were primarily renames of packages containing integrations with
 third-party libraries, such as JUnit, TestNG, Java mocking frameworks, Selenium, and ScalaCheck. The purpose
 of these renames in 3.0.8 is to prepare the way for modularization of these third-party integrations in 
 ScalaTest 3.1.0. This will allow the third-party integrations to be versioned independently with ScalaTest.
 
-To use this plugin, please follows these steps (for Maven, use the <a href="https://github.com/evis/scalafix-maven-plugin">scalafix-maven-plugin</a>): 
+To use this plugin with sbt, please follow these steps ([Maven](https://github.com/evis/scalafix-maven-plugin)
+and [Mill](https://github.com/joan38/mill-scalafix) plugins are also available):
 
-  - Add `sbt-scalafix` to your `project/plugins.sbt`:
+  - Add `sbt-scalafix` to your `project/plugins.sbt` (a [newer version](https://github.com/scalacenter/sbt-scalafix/releases) might be required for the latest Scala releases):
 
 ```
-addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.9.11")
+addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.9.18-1")
 ```
 
-  - Add the following settings to your `build.sbt`:
-
-```
-scalafixDependencies in ThisBuild += "org.scalatest" %% "autofix" % "3.0.8-0"
-
-addCompilerPlugin(scalafixSemanticdb) // enable SemanticDB
-``` 
-
-  - Or, if your project doesn't use a `build.sbt`, you'll need to make the above changes to `project/your-build-file.sbt`.
-
   - If you have `-Xfatal-warnings` set, comment it out for the scalafix process, because otherwise
     the deprecation warnings will stop your build before autofix is given a chance to fix them.
 
 ```
 // scalacOptions += "-Xfatal-warnings"
 ```
 
-  - In the sbt prompt, issue the following command to have autofix applied to your test source files: 
-  
+  - Enable scalafix for the current sbt session:
+
 ```
-sbt> test:scalafix RenameDeprecatedPackage
+sbt> scalafixEnable
 ```
 
-  - In case you want to apply autofix to your main source files, you'll issue the following command: 
+  - In the sbt prompt, issue the following command to have autofix applied to your main & test source files: 
 
 ```
-sbt> scalafix RenameDeprecatedPackage
-```  
+sbt> scalafixAll dependency:RenameDeprecatedPackage@org.scalatest:autofix:3.0.8-0
+```
 
   - Check the changes made with `git diff`.
 
@@ -51,4 +42,3 @@ scalacOptions += "-Xfatal-warnings"
 ```
 
 
-

3.1.x/README.md

@@ -1,46 +1,37 @@
 # Autofix for ScalaTest 3.1.x
-This scalafix application will rewrite your ScalaTest code to eliminate most of the deprecation warnings
+This scalafix rule will rewrite your ScalaTest code to eliminate most of the deprecation warnings
 introduced in ScalaTest 3.1.0. The deprecations were primarily renames of object, classes, and traits to
 pave the way for the internal modularization of ScalaTest in 3.2.0. The internal modularization of ScalaTest
 will allow projects to depend on a chosen subset of ScalaTest in their build to more easily keep test code
 consistent across the project.
 
-To use this plugin with sbt, please follows these steps (for Maven, use the <a href="https://github.com/evis/scalafix-maven-plugin">scalafix-maven-plugin</a>): 
+To use this plugin with sbt, please follow these steps ([Maven](https://github.com/evis/scalafix-maven-plugin)
+and [Mill](https://github.com/joan38/mill-scalafix) plugins are also available):
 
-  - Add `sbt-scalafix` to your `project/plugins.sbt`:
+  - Add `sbt-scalafix` to your `project/plugins.sbt` (a [newer version](https://github.com/scalacenter/sbt-scalafix/releases) might be required for the latest Scala releases):
 
 ```
-addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.9.11")
+addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.9.18-1")
 ```
 
-  - Add the following settings to your `build.sbt`:
-
-```
-scalafixDependencies in ThisBuild += "org.scalatest" %% "autofix" % "3.1.0.0" 
-
-addCompilerPlugin(scalafixSemanticdb) // enable SemanticDB
-``` 
-
-  - Or, if your project doesn't use a `build.sbt`, you'll need to make the above changes to `project/your-build-file.sbt`.
-
   - If you have `-Xfatal-warnings` set, comment it out for the scalafix process, because otherwise
     the deprecation warnings will stop your build before autofix is given a chance to fix them.
 
 ```
 // scalacOptions += "-Xfatal-warnings"
 ```
 
-  - In the sbt prompt, issue the following command to have autofix applied to your test source files: 
-  
+  - Enable scalafix for the current sbt session:
+
 ```
-sbt> test:scalafix RewriteDeprecatedNames
+sbt> scalafixEnable
 ```
 
-  - In case you want to apply autofix to your main source files, you'll issue the following command: 
+  - In the sbt prompt, issue the following command to have autofix applied to your main & test source files: 
 
 ```
-sbt> scalafix RewriteDeprecatedNames
-```  
+sbt> scalafixAll dependency:RewriteDeprecatedNames@org.scalatest:autofix:3.1.0.0
+```
 
   - Check the changes made with `git diff`.
 
@@ -50,5 +41,3 @@ sbt> scalafix RewriteDeprecatedNames
 scalacOptions += "-Xfatal-warnings"
 ```
 
-
-