mutation-testing-metrics-scala 1.7.4 → 1.7.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,38 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [1.7.8](https://github.com/stryker-mutator/mutation-testing-elements/compare/v1.7.7...v1.7.8) (2021-12-09)
7
+
8
+ **Note:** Version bump only for package mutation-testing-metrics-scala
9
+
10
+
11
+
12
+
13
+
14
+ ## [1.7.7](https://github.com/stryker-mutator/mutation-testing-elements/compare/v1.7.6...v1.7.7) (2021-12-09)
15
+
16
+ **Note:** Version bump only for package mutation-testing-metrics-scala
17
+
18
+
19
+
20
+
21
+
22
+ ## [1.7.6](https://github.com/stryker-mutator/mutation-testing-elements/compare/v1.7.5...v1.7.6) (2021-11-19)
23
+
24
+ **Note:** Version bump only for package mutation-testing-metrics-scala
25
+
26
+
27
+
28
+
29
+
30
+ ## [1.7.5](https://github.com/stryker-mutator/mutation-testing-elements/compare/v1.7.4...v1.7.5) (2021-08-01)
31
+
32
+ **Note:** Version bump only for package mutation-testing-metrics-scala
33
+
34
+
35
+
36
+
37
+
6
38
  ## [1.7.4](https://github.com/stryker-mutator/mutation-testing-elements/compare/v1.7.3...v1.7.4) (2021-07-13)
7
39
 
8
40
  **Note:** Version bump only for package mutation-testing-metrics-scala
package/README.md CHANGED
@@ -7,7 +7,7 @@ Zero-dependency library to calculate mutation testing metrics in Scala.
7
7
 
8
8
  See [mutant states and metrics in the Stryker handbook](https://github.com/stryker-mutator/stryker-handbook/blob/master/mutant-states-and-metrics.md#readme) for more details about mutation testing metrics.
9
9
 
10
- Cross-compiled for Scala 2.12 and 2.13. If you want to use this library but require another target or platform (such as [Dotty](https://dotty.epfl.ch/), [Scala.js](http://www.scala-js.org/) or [Scala Native](https://www.scala-native.org/)) feel free to [create an issue](https://github.com/stryker-mutator/mutation-testing-elements/issues/new)!
10
+ Cross-compiled for Scala 2.12, 2.13 and 3.1 on JVM and Scala.js. If you want to use this library but require another target or platform (such as [Scala Native](https://www.scala-native.org/)) feel free to [create an issue](https://github.com/stryker-mutator/mutation-testing-elements/issues/new)!
11
11
 
12
12
  ## Usage example
13
13
 
@@ -17,6 +17,12 @@ Add the dependency to your project [![Maven Central](https://img.shields.io/mave
17
17
  libraryDependencies += "io.stryker-mutator" %% "mutation-testing-metrics" % version
18
18
  ```
19
19
 
20
+ Or for Scala.js:
21
+
22
+ ```scala
23
+ libraryDependencies += "io.stryker-mutator" %%% "mutation-testing-metrics" % version
24
+ ```
25
+
20
26
  The `mutation-testing-elements` and `mutation-testing-report-schema` projects are also published, see [NPM_PROJECTS_PUBLISHING](./NPM_PROJECTS_PUBLISHING.md) for more information.
21
27
 
22
28
  First create the mutation test report:
@@ -117,7 +123,7 @@ metrics.mutationScoreBasedOnCoveredCode
117
123
  // res15: Double = 70.12987012987013
118
124
  ```
119
125
 
120
- - `MetricsResult` is a trait with three implementations:
126
+ - `MetricsResult` is a sealed trait with three implementations:
121
127
  - `MetricsResultRoot`: The root of a `MetricsResult`, contains zero or more `MetricsResult`'s
122
128
  - `MetricsDirectory`: Representation of a directory. Has a directory name and zero or more `MetricsResult`'s
123
129
  - `MetricsFile`: Representation of a file with mutated code. Has a filename and zero or more `MetricMutant`'s
@@ -125,7 +131,7 @@ metrics.mutationScoreBasedOnCoveredCode
125
131
 
126
132
  ## Contributing
127
133
 
128
- To use this project, you will need sbt. The recommended way on macOS/Linux is with [sbt-extras](https://github.com/paulp/sbt-extras). On Windows, you can install sbt using the [official .msi](https://www.scala-sbt.org/download.html).
134
+ To use this project, you will need a [JDK](https://adoptium.net/) and sbt. The recommended way to install sbt is with with [Coursier](https://get-coursier.io/). Alternatively, on macOS/Linux [sbt-extras](https://github.com/dwijnand/sbt-extras), or on Windows using the [official .msi](https://www.scala-sbt.org/download.html) are also options.
129
135
 
130
136
  This is a normal sbt project, you can compile code with `sbt compile` and run tests
131
137
  with `sbt test`. Running `sbt +test` will compile and test all targets. For more information on cross-compilation in sbt, see <https://www.scala-sbt.org/1.x/docs/Cross-Build.html>.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mutation-testing-metrics-scala",
3
- "version": "1.7.4",
3
+ "version": "1.7.8",
4
4
  "description": "Zero-dependency library to calculate mutation testing metrics in Scala.",
5
5
  "scripts": {
6
6
  "test": "sbt \"compile; metrics/test; circe/test; docs/mdoc --check\"",
@@ -17,5 +17,5 @@
17
17
  "url": "https://github.com/stryker-mutator/mutation-testing-elements/issues"
18
18
  },
19
19
  "homepage": "https://github.com/stryker-mutator/mutation-testing-elements/tree/master/packages/metrics-scala#readme",
20
- "gitHead": "6efdfe3d48712ff800bc096c8d1c22756185c464"
20
+ "gitHead": "38c8eaec008ed148223efde4ec5d0545fce1b6ba"
21
21
  }