Update to sbt 1.7 and refactor Checkstyle usage (#4)

* Update sbt to 1.7.1

* Update plugin code to sbt 1.0 style

* Disable scala 3 syntax

* Fix warnings

* Fix loading config from classpath

* Update test files

* wip run directly

* Fix scripted tests

* Finish switching to calling Checkstyle directly

* Remove option from checkstyleSeverityLevel

* Remove option from checkstyleXsltTransformations

* Tidy remaining settings

* Remove debug

* Add release plugin

* Switch to scapegoat

* Add Java 17 to test versions

* Update contributing/contributors

* Update README

Author: stringbean

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        java: [8, 11]
+        java: [8, 11, 17]
     steps:
       - uses: actions/checkout@v2
       - uses: coursier/cache-action@v6
@@ -21,4 +21,4 @@ jobs:
           java-version: ${{matrix.java}}
           distribution: temurin
       - name: Run tests
-        run: sbt test scripted scalastyle scalafmtCheckAll
+        run: sbt test scripted scapegoat scalafmtCheckAll

.gitignore

@@ -2,3 +2,4 @@ target
 project/target
 .idea
 *.iml
+.bsp

.scalafmt.conf

@@ -1,5 +1,5 @@
 version = 3.5.9
-runner.dialect = scala212
+runner.dialect = scala212source3
 
 maxColumn = 120
 

CONTRIBUTING.md

@@ -1,20 +1,38 @@
-# Contribute
-These are the basic steps for contributing to sbt-checkstyle-plugin:
-
-1. Fork from [the master branch](https://github.com/etsy/sbt-checkstyle-plugin)
-2. Make your changes
-3. Document new functionality as appropriate
-4. Add new tests if possible
-5. Run the test suite with `sbt test scripted`
-6. Push your changes to your fork.
-7. Send a pull request!
-
-Every pull request will be built with [Travis CI](https://travis-ci.org/etsy/sbt-checkstyle-plugin).  The CI build runs both unit tests and Scalastyle.
-
-# Contributors
-- Andrew Johnson [ajsquared](https://github.com/ajsquared)
-- Hans L'hoëst [lhohan](https://github.com/lhohan)
-- sentolacco [sentolacco](https://github.com/sentolacco)
-- Joseph Earl [JosephEarl](https://github.com/JosephEarl)
-- Alejandro Rivera [AlejandroRivera](https://github.com/AlejandroRivera)
-- Michael Stringer [stringbean](https://github.com/stringbean)
+# Contributing
+
+When you find a bug in sbt-checkstyle-plugin we want to hear about it. Your bug reports play an important part in making
+this plugin more reliable and usable.
+
+Effective bug reports are more likely to be fixed. These guidelines explain how to write such reports and pull requests.
+
+## Before Reporting an Issue
+
+- Make sure that you are running the latest version of SBT (1.x) and the jacoco4sbt plugin.
+- Check the open [issues](https://github.com/stringbean/sbt-checkstyle-plugin/issues) and
+  [pull requests](https://github.com/stringbean/sbt-checkstyle-plugin/pulls) for anything similar. If there is already 
+  an open issue and you have additional information please add it (comments such as +1 aren't helpful).
+
+## How to Report an Issue
+
+It is important when opening a new issue to include as much information as possible including:
+
+- How to reproduce the issue:
+    - What SBT tasks did you run before `checkstyle`?
+    - Does it always happen?
+- Details of your environment:
+    - Version of sbt.
+    - Version of the sbt-checkstyle-plugin plugin.
+    - Version of Checkstyle.
+- A link to a repo containing your project _or_
+- A link to a Gist/Pastebin with a test case reproducing the issue.
+
+## How to Submit a Pull Request
+
+We welcome code contributions to sbt-checkstyle-plugin. To make it easier for us to include your contributions please
+ensure the  following before creating a pull request:
+
+- Your branch is up-to-date with `main`.
+- All unit tests and scripted tests pass.
+
+When opening a pull request please including any relevant information - such as _"fixes issue #x"_ or _"adds new
+feature y"_.

CONTRIBUTORS.md

@@ -0,0 +1,8 @@
+# Contributors
+
+- Andrew Johnson [ajsquared](https://github.com/ajsquared)
+- Hans L'hoëst [lhohan](https://github.com/lhohan)
+- sentolacco [sentolacco](https://github.com/sentolacco)
+- Joseph Earl [JosephEarl](https://github.com/JosephEarl)
+- Alejandro Rivera [AlejandroRivera](https://github.com/AlejandroRivera)
+- Michael Stringer [stringbean](https://github.com/stringbean)

README.md

@@ -1,10 +1,13 @@
 # sbt-checkstyle-plugin
 
+[![Build Status](https://img.shields.io/github/workflow/status/stringbean/sbt-checkstyle-plugin/ci)](https://github.com/stringbean/sbt-checkstyle-plugin/actions/workflows/ci.yml)
+[![Known Vulnerabilities](https://snyk.io/test/github/stringbean/sbt-checkstyle-plugin/badge.svg?targetFile=build.sbt)](https://snyk.io/test/github/stringbean/sbt-checkstyle-plugin?targetFile=build.sbt)
+![Maven Central](https://maven-badges.herokuapp.com/maven-central/software.purpledragon/sbt-checkstyle-plugin/badge.svg?style=flat)
+![Checkstyle 3.9](https://img.shields.io/badge/Default_Checkstyle-3.9-yellowgreen)
+
 This project provides an sbt plugin for running Checkstyle over Java source files. For more information about 
 Checkstyle, see [checkstyle.sourceforge.io](http://checkstyle.sourceforge.io).
 
-This plugin uses version 6.15 of Checkstyle by default.
-
 This project was forked from [etsy/sbt-checkstyle-plugin](https://github.com/etsy/sbt-checkstyle-plugin) in 2022
 after it became unmaintained. Some initial code was based on an
 [earlier plugin](https://github.com/corux/sbt-code-quality) (dead link). 
@@ -17,20 +20,20 @@ Add the following lines to `project/plugins.sbt`:
 addSbtPlugin("software.purpledragon" % "sbt-checkstyle-plugin" % "<version>")
 ```
 
-sbt-checkstyle-plugin is an AutoPlugin, so there is no need to modify the `build.sbt` file to enable it.
+Checkstyle will be enabled by default for projects.
 
 ## Usage
 
 You can run Checkstyle over your Java source files with the `checkstyle` task. You can run Checkstyle over your Java
-tests with the `test:checkstyle` task.
+tests with the `Test / checkstyle` task.
 
-The Checkstyle configuration file is `./checkstyle-config.xml` by default. This can be changed by setting the value of
-`checkstyleConfigLocation`.  By default `test:checkstyle` uses the same  configuration file, but this can be changed by
-setting the value of `checkstyleConfigLocation in Test`.
+The Checkstyle configuration file is `checkstyle-config.xml` by default. This can be changed by setting the value of
+`checkstyleConfigLocation`.  By default `Test / checkstyle` uses the same  configuration file, but this can be changed
+by setting the value of `Test / checkstyleConfigLocation`.
 
 The Checkstyle report is output to `target/checkstyle-report.xml` by default. This can be changed by setting the value
-of `checkstyleOutputFile`. `test:checkstyle` outputs to `target/checkstyle-test-report.xml`, but this can be changed by
-setting the value of `checkstyleOutputFile in Test`.
+of `checkstyleOutputFile`. `Test / checkstyle` outputs to `target/checkstyle-test-report.xml`, but this can be changed
+by setting the value of `Test / checkstyleOutputFile`.
 
 To change the checkstyle configuration file set `checkstyleConfigLocation` in `build.sbt`:
 ```scala
@@ -50,36 +53,36 @@ checkstyleConfigLocation := CheckstyleConfigLocation.Classpath("com/etsy/checkst
 
 To run Checkstyle automatically after compilation:
 ```scala
-(checkstyle in Compile) := (checkstyle in Compile).triggeredBy(compile in Compile).value
+(Compile / checkstyle) := (Compile / checkstyle).triggeredBy(Compile / compile).value
 ```
 
 To run Checkstyle automatically after test compilation:
 ```scala
-(checkstyle in Test) := (checkstyle in Test).triggeredBy(compile in Test).value
+(Test / checkstyle) := (Test / checkstyle).triggeredBy(Test / compile).value
 ```
 
 ### XSLT transformations
 
 The `checkstyleXsltTransformations` setting allows applying XSLT transformations to the XML report generated by
 Checkstyle. For instance, this could be used to generate a more readable HTML report. This setting takes values of
-`Option[Set[XSLTSettings]]`, so multiple transformations can be applied.
+`Set[XSLTSettings]`, so multiple transformations can be applied.
 
 You can set `checkstyleXsltTransformations` like so in `build.sbt`:
 ```scala
-checkstyleXsltTransformations := {
-  Some(Set(CheckstyleXSLTSettings(baseDirectory(_ / "checkstyle-noframes.xml").value, target(_ / "checkstyle-report.html").value)))
-}
+checkstyleXsltTransformations +=
+  CheckstyleXSLTSettings(baseDirectory.value / "checkstyle-noframes.xml", target.value / "checkstyle-report.html")
 ```
 
 ### Failing the build
 
 You can control what severity of issues should break the build by setting the `checkstyleSeverityLevel` in your
 `build.sbt` as follows:
+
 ```scala
-checkstyleSeverityLevel := Some(CheckstyleSeverityLevel.Error)
+checkstyleSeverityLevel := CheckstyleSeverityLevel.Error
 ```
 
-Possible values are defined by the `CheckstyleSeverityLevel` enumeration. The default is `None`.
+Possible values are defined by the `CheckstyleSeverityLevel` enumeration. The default is `Ignore`.
 
 ### Integration tests
 
@@ -89,12 +92,12 @@ lazy val root = (project in file(".")).configs(IntegrationTest)
 
 Defaults.itSettings
 
-checkstyleConfigLocation := CheckstyleConfigLocation.File("my-checkstyle-config.xml"),
-checkstyle in IntegrationTest := checkstyleTask(IntegrationTest).value,
-checkstyleOutputFile in IntegrationTest := target.value / "checkstyle-integration-test-report.xml"
+checkstyleConfigLocation := CheckstyleConfigLocation.File("my-checkstyle-config.xml")
+IntegrationTest / checkstyle := checkstyleTask(IntegrationTest).value
+IntegrationTest / checkstyleOutputFile := target.value / "checkstyle-integration-test-report.xml"
 ```
 
-You can then run the tasks `it:checkstyle` and `it:checkstyle-check`.
+You can then run the tasks `IntegrationTest / checkstyle` and `IntegrationTest / checkstyle-check`.
 
 ### Upgrading Checkstyle version
 
@@ -104,27 +107,31 @@ Provided the new Checkstyle version is compatible, you can override the version
 `project/plugins.sbt`:
 
 ```scala
-dependencyOverrides += "com.puppycrawl.tools" % "checkstyle" % "6.15"
+dependencyOverrides += "com.puppycrawl.tools" % "checkstyle" % "10.3"
 ```
 
 ## Settings
 
 ### `checkstyleOutputFile`
-* *Description:* The location of the generated checkstyle report.
-* *Accepts:* any legal file path
-* *Default:* `Some(target.value / "checkstyle-report.xml")`
+
+- **Description:** The location of the generated checkstyle report.
+- **Accepts:** `File`
+- **Default:** `target.value / "checkstyle-report.xml"`
 
 ### `checkstyleConfigLocation`
-* *Description:* The location of the checkstyle configuration file.
-* *Accepts:* `CheckstyleConfigLocation.{File, URL, Classpath}`
-* *Default:* `CheckstyleConfigLocation.File("checkstyle-config.xml")`
+
+- **Description:** The location of the checkstyle configuration file.
+- **Accepts:** `CheckstyleConfigLocation` (`.File`, `.URL`, `.Classpath`)
+- **Default:** `CheckstyleConfigLocation.File("checkstyle-config.xml")`
 
 ### `checkstyleXsltTransformations`
-* *Description:* A set of XSLT transformations to be applied to the checkstyle output (optional).
-* *Accepts:* `Some(Set[CheckstyleXSLTSettings])`
-* *Default:* `None`
+
+- **Description:** A set of XSLT transformations to be applied to the checkstyle output.
+- **Accepts:** `Set[CheckstyleXSLTSettings]`
+- **Default:** `Set.empty`
 
 ### `checkstyleSeverityLevel`
-* *Description:* Decide how much effort to put into analysis.
-* *Accepts:* `Some(CheckstyleSeverityLevel.{Ignore, Info, Warning, Error})`
-* *Default:* `None`
+
+- **Description:** Decide how much effort to put into analysis.
+- **Accepts:** `CheckstyleSeverityLevel` (`Ignore`, `Info`, `Warning`, `Error`)
+- **Default:** `CheckstyleSeverityLevel.Ignore`

build.sbt

@@ -1,21 +1,14 @@
 name         := "sbt-checkstyle-plugin"
 organization := "software.purpledragon"
 
-version := "3.3.1-SNAPSHOT"
-
-sbtPlugin := true
+enablePlugins(SbtPlugin)
 
 libraryDependencies ++= Seq(
-  "com.puppycrawl.tools"     % "checkstyle"      % "9.3",
-  "com.github.sbt"           % "junit-interface" % "0.13.3" % Test,
-  "junit"                    % "junit"           % "4.13.2" % Test,
-  "com.github.stefanbirkner" % "system-rules"    % "1.19.0" % Test
+  "com.puppycrawl.tools" % "checkstyle" % "9.3"
 )
 
 licenses += ("MIT", url("https://opensource.org/licenses/MIT"))
 
-publishTo := sonatypePublishToBundle.value
-
 developers := List(
   Developer(
     "stringbean",
@@ -33,5 +26,37 @@ scmInfo  := Some(
   )
 )
 
-scalastyleConfig      := file("scalastyle.xml")
-scalastyleFailOnError := true
+ThisBuild / scapegoatVersion := "1.4.15"
+
+scriptedLaunchOpts := {
+  scriptedLaunchOpts.value ++
+    Seq("-Xmx1024M", "-Dplugin.version=" + version.value)
+}
+
+scalacOptions := Seq(
+  "-deprecation",
+  "-feature",
+  "-unchecked",
+  "-Xlint:unused"
+)
+
+publishTo := sonatypePublishToBundle.value
+
+import sbtrelease.ReleasePlugin.autoImport.ReleaseTransformations._
+
+releaseProcess := Seq[ReleaseStep](
+  checkSnapshotDependencies,
+  inquireVersions,
+  runClean,
+  runTest,
+  releaseStepInputTask(scripted),
+  releaseStepTask(scapegoat),
+  setReleaseVersion,
+  commitReleaseVersion,
+  tagRelease,
+  publishArtifacts,
+  releaseStepCommand("sonatypeBundleRelease"),
+  setNextVersion,
+  commitNextVersion,
+  pushChanges
+)

project/build.properties

@@ -1 +1 @@
-sbt.version=1.1.0
+sbt.version=1.7.1

project/plugins.sbt

@@ -1,7 +1,8 @@
 // publishing
 addSbtPlugin("org.xerial.sbt" % "sbt-sonatype" % "3.8.1")
 addSbtPlugin("com.github.sbt" % "sbt-pgp"      % "2.1.2")
+addSbtPlugin("com.github.sbt" % "sbt-release"  % "1.1.0")
 
 // code style
-addSbtPlugin("org.scalastyle" % "scalastyle-sbt-plugin" % "1.0.0")
-addSbtPlugin("org.scalameta"  % "sbt-scalafmt"          % "2.4.6")
+addSbtPlugin("org.scalameta"           % "sbt-scalafmt"  % "2.4.6")
+addSbtPlugin("com.sksamuel.scapegoat" %% "sbt-scapegoat" % "1.1.1")