From 8d09d73efeb71e6a1ac5db17f3c5180350676952 Mon Sep 17 00:00:00 2001 From: Thibault Czarniak Date: Thu, 12 Sep 2024 11:20:15 +0200 Subject: [PATCH] Updated README with rule implementation list and better install instructions --- readme.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index e43bfe1..07d9dcc 100644 --- a/readme.md +++ b/readme.md @@ -14,10 +14,17 @@ This project is a Scalafix implementation of the Scapegoat linter for Scala 3. It contains a set of rules that can be run on Scala code to detect potential issues and bad practices. The rules are based on the Scapegoat linter for Scala 2, but have been adapted to work with Scalafix and Scala 3. For now, this project has 52 rules but more are being worked on. +You can track the progress [here](https://docs.google.com/spreadsheets/d/1XovJJg3EInQFFL1-tpqGxpP2O4RFzCOF7zDalQIeB7E/edit?usp=sharing). ## Installation -To install the rules, simply add the following to your `build.sbt` file: +To install the rules, you first should have the Scalafix plugin installed. +You can install it by adding this line to `project/plugins.sbt`: +``` +addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.12.1") +``` + +Then, to obtain this rule set, simply add the following line to your `build.sbt` file: ``` ThisBuild / scalafixDependencies += "io.github.dedis" %% "scapegoat-scalafix" % "1.1.2" ```