.git-blame-ignore-revs

@@ -4,3 +4,6 @@
 #
 # Added scalafmt
 af2396558918fea00eaa2da12906a3012eb72153
+
+# Scala Steward: Reformat with scalafmt 3.5.9
+e233420d8f4cdd863932d3c1c41deb2da6c1bace

.github/workflows/ci.yml

@@ -6,44 +6,50 @@ on:
       - '*.md'
     branches:
       - main
+      - V2
   pull_request:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        java: [ '8', '11' ]
+        java: [ '8', '17' ]
+        os: [ 'ubuntu-latest' ]
 
     steps:
       - name: checkout the repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
+      - uses: sbt/setup-sbt@v1
+
       - name: Set up JVM
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v4
         with:
-          distribution: 'adopt'
+          distribution: 'temurin'
           java-version: ${{ matrix.java }}
 
       - name: Run tests
-        run: sbt scripted
+        run: sbt scripted "++ 3.x" test
 
   formatting:
     runs-on: ubuntu-latest
 
     steps:
       - name: checkout the repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Set up JVM
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v4
         with:
-          distribution: 'adopt'
-          java-version: '8'
+          distribution: 'temurin'
+          java-version: '11'
+
+      - uses: sbt/setup-sbt@v1
 
       - name: Check Formatting
-        run: sbt scalafmtCheckAll
+        run: sbt scalafmtSbtCheck "+ scalafmtCheckAll"

.github/workflows/release-drafter.yml

@@ -9,6 +9,6 @@ jobs:
   update_release_draft:
     runs-on: ubuntu-latest
     steps:
-      - uses: release-drafter/release-drafter@v5
+      - uses: release-drafter/release-drafter@v6
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -6,15 +6,16 @@ on:
     tags: ["*"]
 jobs:
   publish:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/setup-java@v2
+      - uses: actions/setup-java@v4
         with:
-          distribution: 'adopt'
+          distribution: 'temurin'
           java-version: '11'
+      - uses: sbt/setup-sbt@v1
       - run: sbt ci-release
         env:
           PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}

.gitignore

@@ -8,9 +8,10 @@ target/
 .project
 .settings/
 
-# Scala-IDE specific
-.cache-main
-.cache-tests
+# Metals specific
+.bsp
+metals.sbt
+.metals
 
 # IntelliJ IDEA specific
 .idea

.scalafmt.conf

@@ -1 +1,3 @@
-version = "3.0.3"
+version = "3.9.4"
+project.git = true
+runner.dialect = "scala213"

README.md

@@ -1,31 +1,40 @@
 # sbt-scoverage
 
-[![Gitter](https://img.shields.io/gitter/room/scoverage/scoverage.svg)](https://gitter.im/scoverage/scoverage)
-[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.scoverage/sbt-scoverage/badge.svg?kill_cache=1)](https://search.maven.org/artifact/org.scoverage/sbt-scoverage/)
-[![License](http://img.shields.io/:license-Apache%202-red.svg)](http://www.apache.org/licenses/LICENSE-2.0.txt)
+[![gitter-badge][]][gitter]
+[![maven-badge][]][maven]
+[![license-badge][]][license]
 
-sbt-scoverage is a plugin for sbt that integrates the scoverage code coverage
-library. Find out more about
-[scoverage here](https://github.com/scoverage/scalac-scoverage-plugin).
+sbt-scoverage is an sbt plugin that offers support for Scala code
+coverage using [scoverage][]. This plugin supports Scala 2.12, 2.13,
+and 3.
+
+**NOTE**: ScalaJS and Scala Native support is limited to Scala 2.
+
+**NOTE**: Scala 3 support starts with 3.2.x.
 
 ## Setup
 
-**Requirements**: Requires sbt 1.2.8 or above
+**Requirements**: Requires sbt 1.2.8 or above.
 
 In `project/plugins.sbt`:
 ```scala
 addSbtPlugin("org.scoverage" % "sbt-scoverage" % "x.x.x")
 ```
 
+If you are in an enterprise environment, and the above does not work, try:
+```scala
+libraryDependencies += "org.scoverage" % "sbt-scoverage_2.12_1.0" % "x.x.x"
+```
+
 ## Usage
 
 Run the tests with enabled coverage:
 ```
-$ sbt clean coverage test
+sbt clean coverage test
 ```
 or if you have integration tests as well
 ```
-$ sbt clean coverage it:test
+sbt clean coverage it:test
 ```
 
 To enable coverage directly in your build, use:
@@ -35,43 +44,57 @@ coverageEnabled := true
 
 To generate the coverage reports run
 ```
-$ sbt coverageReport
+sbt coverageReport
 ```
 
-Coverage reports will be in your `target/scala-<scala-version>/scoverage-report`
-directory.  There are HTML and XML reports. The XML is useful if you need to
-programatically use the results, or if you're writing a tool.
+Coverage reports will be in your
+`target/scala-<scala-version>/scoverage-report` directory.  There are
+HTML and XML reports. The XML is useful if you need to programatically
+use the results, or if you're writing a tool.
 
-**NOTE**: If you're running the coverage reports from within an sbt console
-session (as opposed to one command per sbt launch), then the `coverage` command
-is sticky.  To turn it back off when you're done running reports, use the
-`coverageOff` command or reset `coverageEnabled` with `set coverageEnabled :=
-false`.
+**NOTE**: If you're running the coverage reports from within an sbt
+console session (as opposed to one command per sbt launch), then the
+`coverage` command is sticky.  To turn it back off when you're done
+running reports, use the `coverageOff` command or reset
+`coverageEnabled` with `set coverageEnabled := false`.
 
 ### Multi project reports
 
-By default, scoverage will generate reports for each project separately. You can
-merge them into an aggregated report by using the following:
+By default, scoverage will generate reports for each project
+separately. You can merge them into an aggregated report by using the
+following:
 
 ```
 $ sbt coverageAggregate
 ```
 
-**NOTE**: You do not need to run `coverageReport` before `coverageAggregate`; it
-aggregates over the sub-projects' coverage data directly, not the report xml.
+**NOTE**: You do not need to run `coverageReport` before
+`coverageAggregate`; it aggregates over the sub-projects' coverage
+data directly, not the report xml.
 
-### Exclude classes and packages
+### Exclude classes and packages and files
 
-You can exclude classes from being considered for coverage measurement by
-providing semicolon-separated list of regular expressions.
+You can exclude classes from being considered for coverage measurement
+by providing semicolon-separated list of regular expressions.
 
 ```scala
 coverageExcludedPackages := "<empty>;Reverse.*;.*AuthService.*;models\\.data\\..*"
 ```
 
-The regular expressions are matched against the fully qualified class name, and
-must match the entire string to take effect.  Any matched classes will not be
-instrumented or included in the coverage report.
+The regular expressions are matched against the fully qualified class
+name, and must match the entire string to take effect.  Any matched
+classes will not be instrumented or included in the coverage report.
+
+You can also exclude files and file paths.
+
+```scala
+coverageExcludedFiles := ".*\\/two\\/GoodCoverage;.*\\/three\\/.*"
+```
+
+**NOTE**: The `.scala` file extension needs to be omitted from the
+filename, if one is given.
+
+**NOTE**: These two options only work for Scala2, Scala 3.3.4+ and Scala 3.4.2+.
 
 You can also mark sections of code with comments like:
 
@@ -84,6 +107,8 @@ You can also mark sections of code with comments like:
 Any code between two such comments will not be instrumented or included in the
 coverage report.
 
+**NOTE**: Comments exclusion works only for Scala2.
+
 ### Minimum coverage
 
 Based on minimum coverage, you can fail the build with the following keys:
@@ -98,13 +123,14 @@ coverageMinimumStmtPerFile := 85
 coverageMinimumBranchPerFile := 80
 ```
 
-These settings will be enforced when the reports are generated.  If you generate
-an aggregate report using `coverageAggregate` then these settings will apply to
-that report.
+These settings will be enforced when the reports are generated.  If
+you generate an aggregate report using `coverageAggregate` then these
+settings will apply to that report.
 
 ### Override Location for Coverage Data And Report
 
-If desired, one could override the default location for generating the sbt report and data through setting `coverageDataDir`:
+If desired, one could override the default location for generating the
+sbt report and data through setting `coverageDataDir`:
 
 Example in data-dir test:
 ```scala
@@ -116,52 +142,70 @@ Can also be set through the sbt set directive
 set coverageDataDir := file("/tmp")
 ```
 
-
 ## Trouble-shooting failing tests
 
-scoverage does a lot of file writing behind the scenes in order to track which
-statements have been executed.  If you are running into a scenario where your
-tests normally pass, but fail when scoverage is enabled, then the culprit can be
-one of the following:
+scoverage does a lot of file writing behind the scenes in order to
+track which statements have been executed.  If you are running into a
+scenario where your tests normally pass, but fail when scoverage is
+enabled, then the culprit can be one of the following:
 
-* timing issues on futures and other async operations, try upping the timeouts by an order of magnitude.
-* tests are run in a sandbox mode (such as with `java.security.PrivilegedAction<T>`), try running the tests outside of the sandbox.
+* timing issues on futures and other async operations, try upping the
+  timeouts by an order of magnitude.
+* tests are run in a sandbox mode (such as with
+  `java.security.PrivilegedAction<T>`), try running the tests outside
+  of the sandbox.
 
 ## Example project
 
-[the scoverage samples project](https://github.com/scoverage/sbt-scoverage-samples).
+To see the plugin in action you can checkout the scoverage [samples][]
+project.
 
 ## Integrations
 
 ### Codacy
 
-[Codacy](https://www.codacy.com) integrates with your favorite coverage tool to
-provide an in-depth overlook of your project status. scoverage information can
-be integrated into Codacy through the
-[codacy-coverage-reporter](https://github.com/codacy/codacy-coverage-reporter).
+[Codacy][] integrates with your favorite coverage tool to provide an
+in-depth overlook of your project status. scoverage information can be
+integrated into Codacy through the [codacy-coverage-reporter][].
 
 ### Coveralls
 
-If you have an open source project then you can add code coverage metrics with
-the [Coveralls](https://coveralls.io/). scoverage will integrate with coveralls
-using the [sbt-coveralls](https://github.com/scoverage/sbt-coveralls) plugin.
+If you have an open source project then you can publish the code
+coverage metrics with [Coveralls][]. This plugin will integrate with
+coveralls using the [sbt-coveralls][] plugin.
 
 ### Codecov
 
-You can integrate with [Codecov](https://about.codecov.io/) easily sending your
-reports there via your CI. You can see an example of this here in
-[codecov/example-scala](https://github.com/codecov/example-scala).
+You can also integrate with [Codecov][] by sending your reports there
+via your CI. You can see an example in [codecov-example-scala][].
 
-### Plugin for SonarQube
+### SonarQube
 
-If you want to visually browse statement coverage reports then use this [plugin
-for SonarQube](https://github.com/RadoBuransky/sonar-scoverage-plugin).  It
-allows you to review overall project statement coverage as well as dig deeper
-into sub-modules, directories and source code files to see uncovered statements.
-Statement coverage measurement can become an integral part of your team's
-continuous integration process and a required quality standard.
+If you want to visually browse coverage reports then you can use the
+[SonarQube][] plugin. It allows you to review overall project
+statement coverage as well as dig deeper into sub-modules, directories
+and source code files to see uncovered statements.  Statement coverage
+measurement can become an integral part of your team's continuous
+integration process and a required quality standard.
 
 ## Release Notes
 
-For any information on releases and upgrading, please refer to the [release
-page](https://github.com/scoverage/sbt-scoverage/releases).
+For any information on releases and upgrading, please refer to the
+[release][] page.
+
+[Codacy]: https://www.codacy.com
+[Codecov]: https://about.codecov.io
+[Coveralls]: https://coveralls.io
+[SonarQube]: https://github.com/RadoBuransky/sonar-scoverage-plugin
+[codacy-coverage-reporter]: https://github.com/codacy/codacy-coverage-reporter
+[codecov-example-scala]: https://github.com/codecov/example-scala
+[gitter-badge]: https://img.shields.io/gitter/room/scoverage/scoverage.svg
+[gitter]: https://gitter.im/scoverage/scoverage
+[license-badge]: http://img.shields.io/:license-Apache%202-red.svg
+[license]: http://www.apache.org/licenses/LICENSE-2.0.txt
+[maven-badge]: https://index.scala-lang.org/scoverage/sbt-scoverage/sbt-scoverage/latest.svg
+[maven]: https://search.maven.org/artifact/org.scoverage/sbt-scoverage
+[release]: https://github.com/scoverage/sbt-scoverage/releases
+[samples]: https://github.com/scoverage/sbt-scoverage-samples
+[sbt-coveralls]: https://github.com/scoverage/sbt-coveralls
+[scoverage]: https://github.com/scoverage/scalac-scoverage-plugin