Skip to content
This repository was archived by the owner on Jan 24, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs-sources/integrations/cats.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This module contains integration layer between [org.typelevel.cats](https://gith
## sbt

```scala
"com.softwaremill.diffx" %% "diffx-cats" % "@VERSION@" % Test
"com.softwaremill.diffx" %% "diffx-cats" % "@VERSION@" % Test
```

## mill
Expand All @@ -17,6 +17,7 @@ ivy"com.softwaremill.diffx::diffx-cats::@VERSION@"
## Usage

Assuming you have some data types from the cats library in your hierarchy:

```scala mdoc:silent
import cats.data._
case class TestData(ints: NonEmptyList[String])
Expand All @@ -33,4 +34,4 @@ import com.softwaremill.diffx.generic.auto._

import com.softwaremill.diffx.cats._
compare(t1, t2)
```
```
4 changes: 2 additions & 2 deletions docs-sources/integrations/refined.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This module contains integration layer between [eu.timepit.refined](https://gith
## sbt

```scala
"com.softwaremill.diffx" %% "diffx-refined" % "@VERSION@" % Test
"com.softwaremill.diffx" %% "diffx-refined" % "@VERSION@" % Test
```

## mill
Expand Down Expand Up @@ -37,4 +37,4 @@ import com.softwaremill.diffx.generic.auto._

import com.softwaremill.diffx.refined._
compare(t1, t2)
```
```
4 changes: 2 additions & 2 deletions docs-sources/integrations/tagging.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This module contains integration layer between [com.softwaremill.common.tagging]
"com.softwaremill.diffx" %% "diffx-tagging" % "@VERSION@"
```

## mill
## mill

```scala
ivy"com.softwaremill.diffx::diffx-tagging::@VERSION@"
Expand Down Expand Up @@ -36,4 +36,4 @@ import com.softwaremill.diffx.generic.auto._

import com.softwaremill.diffx.tagging._
compare(t1, t2)
```
```
19 changes: 9 additions & 10 deletions docs-sources/test-frameworks/munit.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,12 @@ assertEqual(left, right)
Below table shows past Diffx releases with the corresponding munit version they were build with.
For newer versions checkout the release changelog.

| Diffx | scalatest |
|--------|:---------:|
| 0.7.0 | 0.7.29 |
| 0.6.0 | 0.7.29 |
| 0.5.6 | 0.7.28 |
| 0.5.5 | 0.7.27 |
| 0.5.4 | 0.7.27 |
| 0.5.3 | 0.7.26 |
| 0.5.2 | 0.7.26 |

| Diffx | scalatest |
| ----- | :-------: |
| 0.7.0 | 0.7.29 |
| 0.6.0 | 0.7.29 |
| 0.5.6 | 0.7.28 |
| 0.5.5 | 0.7.27 |
| 0.5.4 | 0.7.27 |
| 0.5.3 | 0.7.26 |
| 0.5.2 | 0.7.26 |
8 changes: 6 additions & 2 deletions docs-sources/test-frameworks/scalatest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,35 @@ To use with scalatest, add the following dependency:
## sbt

For use with `should` matchers:

```scala
"com.softwaremill.diffx" %% "diffx-scalatest-should" % "@VERSION@" % Test
```

For use with `must` matchers:

```scala
"com.softwaremill.diffx" %% "diffx-scalatest-must" % "@VERSION@" % Test
```

## mill

For use with `should` matchers:

```scala
ivy"com.softwaremill.diffx::diffx-scalatest-must::@VERSION@"
```

For use with `must` matchers:

```scala
ivy"com.softwaremill.diffx::diffx-scalatest-must::@VERSION@"
```

## Usage

Then, depending on the chosen matcher style extend or import relevant trait/object:

- should -> `com.softwaremill.diffx.scalatest.DiffShouldMatcher`
- must -> `com.softwaremill.diffx.scalatest.DiffMustMatcher`

Expand Down Expand Up @@ -63,7 +68,7 @@ Below table shows past Diffx releases with the corresponding scalatest version t
For newer versions checkout the release changelog.

| Diffx | scalatest |
|--------|:---------:|
| ------ | :-------: |
| 0.7.0 | 3.2.10 |
| 0.6.0 | 3.2.10 |
| 0.5.x | 3.2.9 |
Expand All @@ -76,4 +81,3 @@ For newer versions checkout the release changelog.
| 0.3.30 | 3.2.3 |
| 0.3.29 | 3.1.2 |
| 0.3.28 | 3.1.1 |

3 changes: 1 addition & 2 deletions docs-sources/test-frameworks/specs2.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Below table shows past Diffx releases with the corresponding specs2 version they
For newer versions checkout the release changelog.

| Diffx | scalatest |
|--------|:------------:|
| ------ | :----------: |
| 0.7.0 | 4.13.1 |
| 0.6.0 | 4.13.0 |
| 0.5.6 | 4.12.4-js-ec |
Expand All @@ -68,4 +68,3 @@ For newer versions checkout the release changelog.
| 0.3.30 | 4.10.5 |
| 0.3.29 | 4.9.4 |
| 0.3.28 | 4.9.3 |

3 changes: 1 addition & 2 deletions docs-sources/test-frameworks/utest.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Below table shows past Diffx releases with the corresponding utest version they
For newer versions checkout the release changelog.

| Diffx | scalatest |
|--------|:---------:|
| ------ | :-------: |
| 0.7.0 | 0.7.10 |
| 0.6.0 | 0.7.10 |
| 0.5.x | 0.7.10 |
Expand All @@ -61,4 +61,3 @@ For newer versions checkout the release changelog.
| 0.3.30 | 0.7.5 |
| 0.3.29 | 0.7.4 |
| 0.3.28 | 0.7.4 |

2 changes: 1 addition & 1 deletion docs-sources/test-frameworks/weaver.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ To use with weaver, add the following dependency:
## sbt

```scala
"com.softwaremill.weaver" %% "diffx-weaver" % "@VERSION@" % Test
"com.softwaremill.diffx" %% "diffx-weaver" % "@VERSION@" % Test
```

## mill
Expand Down
1 change: 1 addition & 0 deletions generated-docs/out/integrations/cats.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ ivy"com.softwaremill.diffx::diffx-cats::0.9.0"
## Usage

Assuming you have some data types from the cats library in your hierarchy:

```scala
import cats.data._
case class TestData(ints: NonEmptyList[String])
Expand Down
2 changes: 1 addition & 1 deletion generated-docs/out/integrations/tagging.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This module contains integration layer between [com.softwaremill.common.tagging]
"com.softwaremill.diffx" %% "diffx-tagging" % "0.9.0"
```

## mill
## mill

```scala
ivy"com.softwaremill.diffx::diffx-tagging::0.9.0"
Expand Down
19 changes: 9 additions & 10 deletions generated-docs/out/test-frameworks/munit.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,12 @@ assertEqual(left, right)
Below table shows past Diffx releases with the corresponding munit version they were build with.
For newer versions checkout the release changelog.

| Diffx | scalatest |
|--------|:---------:|
| 0.7.0 | 0.7.29 |
| 0.6.0 | 0.7.29 |
| 0.5.6 | 0.7.28 |
| 0.5.5 | 0.7.27 |
| 0.5.4 | 0.7.27 |
| 0.5.3 | 0.7.26 |
| 0.5.2 | 0.7.26 |

| Diffx | scalatest |
| ----- | :-------: |
| 0.7.0 | 0.7.29 |
| 0.6.0 | 0.7.29 |
| 0.5.6 | 0.7.28 |
| 0.5.5 | 0.7.27 |
| 0.5.4 | 0.7.27 |
| 0.5.3 | 0.7.26 |
| 0.5.2 | 0.7.26 |
8 changes: 6 additions & 2 deletions generated-docs/out/test-frameworks/scalatest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,35 @@ To use with scalatest, add the following dependency:
## sbt

For use with `should` matchers:

```scala
"com.softwaremill.diffx" %% "diffx-scalatest-should" % "0.9.0" % Test
```

For use with `must` matchers:

```scala
"com.softwaremill.diffx" %% "diffx-scalatest-must" % "0.9.0" % Test
```

## mill

For use with `should` matchers:

```scala
ivy"com.softwaremill.diffx::diffx-scalatest-must::0.9.0"
```

For use with `must` matchers:

```scala
ivy"com.softwaremill.diffx::diffx-scalatest-must::0.9.0"
```

## Usage

Then, depending on the chosen matcher style extend or import relevant trait/object:

- should -> `com.softwaremill.diffx.scalatest.DiffShouldMatcher`
- must -> `com.softwaremill.diffx.scalatest.DiffMustMatcher`

Expand Down Expand Up @@ -63,7 +68,7 @@ Below table shows past Diffx releases with the corresponding scalatest version t
For newer versions checkout the release changelog.

| Diffx | scalatest |
|--------|:---------:|
| ------ | :-------: |
| 0.7.0 | 3.2.10 |
| 0.6.0 | 3.2.10 |
| 0.5.x | 3.2.9 |
Expand All @@ -76,4 +81,3 @@ For newer versions checkout the release changelog.
| 0.3.30 | 3.2.3 |
| 0.3.29 | 3.1.2 |
| 0.3.28 | 3.1.1 |

3 changes: 1 addition & 2 deletions generated-docs/out/test-frameworks/specs2.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Below table shows past Diffx releases with the corresponding specs2 version they
For newer versions checkout the release changelog.

| Diffx | scalatest |
|--------|:------------:|
| ------ | :----------: |
| 0.7.0 | 4.13.1 |
| 0.6.0 | 4.13.0 |
| 0.5.6 | 4.12.4-js-ec |
Expand All @@ -68,4 +68,3 @@ For newer versions checkout the release changelog.
| 0.3.30 | 4.10.5 |
| 0.3.29 | 4.9.4 |
| 0.3.28 | 4.9.3 |

3 changes: 1 addition & 2 deletions generated-docs/out/test-frameworks/utest.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Below table shows past Diffx releases with the corresponding utest version they
For newer versions checkout the release changelog.

| Diffx | scalatest |
|--------|:---------:|
| ------ | :-------: |
| 0.7.0 | 0.7.10 |
| 0.6.0 | 0.7.10 |
| 0.5.x | 0.7.10 |
Expand All @@ -61,4 +61,3 @@ For newer versions checkout the release changelog.
| 0.3.30 | 0.7.5 |
| 0.3.29 | 0.7.4 |
| 0.3.28 | 0.7.4 |

2 changes: 1 addition & 1 deletion generated-docs/out/test-frameworks/weaver.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ To use with weaver, add the following dependency:
## sbt

```scala
"com.softwaremill.weaver" %% "diffx-weaver" % "0.9.0" % Test
"com.softwaremill.diffx" %% "diffx-weaver" % "0.9.0" % Test
```

## mill
Expand Down
2 changes: 1 addition & 1 deletion generated-docs/out/usage/ignoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ implicit val conf: DiffConfiguration = DiffConfiguration(makeIgnored =
)
// conf: DiffConfiguration = DiffConfiguration(makeIgnored = <function1>)
val d = Diff[Person].ignore(_.age)
// d: Diff[Person] = com.softwaremill.diffx.Diff$$anon$1@32c068ef
// d: Diff[Person] = com.softwaremill.diffx.Diff$$anon$1@5a5ef32b
d(Person("bob", 25), Person("bob", 30))
// res2: DiffResult = DiffResultObject(
// name = "Person",
Expand Down
14 changes: 7 additions & 7 deletions generated-docs/out/usage/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ By default, it is set to an identical function.
```scala
implicit val showConfig = ShowConfig.default.copy(transformer = DiffResultTransformer.skipIdentical)
// showConfig: ShowConfig = ShowConfig(
// left = com.softwaremill.diffx.ShowConfig$$$Lambda$11385/0x0000000801da75d0@482f0f0e,
// right = com.softwaremill.diffx.ShowConfig$$$Lambda$11385/0x0000000801da75d0@2f117bce,
// missing = com.softwaremill.diffx.ShowConfig$$$Lambda$11385/0x0000000801da75d0@427879ce,
// additional = com.softwaremill.diffx.ShowConfig$$$Lambda$11385/0x0000000801da75d0@25da3ed0,
// default = com.softwaremill.diffx.ShowConfig$$$Lambda$11388/0x0000000801dac000@153d021a,
// arrow = com.softwaremill.diffx.ShowConfig$$$Lambda$11385/0x0000000801da75d0@3156c478,
// transformer = com.softwaremill.diffx.DiffResultTransformer$$$Lambda$11377/0x0000000801da55a8@30616d95
// left = com.softwaremill.diffx.ShowConfig$$$Lambda$8615/0x0000000802442040@681cf3e3,
// right = com.softwaremill.diffx.ShowConfig$$$Lambda$8615/0x0000000802442040@243d6896,
// missing = com.softwaremill.diffx.ShowConfig$$$Lambda$8615/0x0000000802442040@48486ddd,
// additional = com.softwaremill.diffx.ShowConfig$$$Lambda$8615/0x0000000802442040@6596e0ee,
// default = com.softwaremill.diffx.ShowConfig$$$Lambda$8618/0x0000000802450040@6a1a9454,
// arrow = com.softwaremill.diffx.ShowConfig$$$Lambda$8615/0x0000000802442040@25ac2859,
// transformer = com.softwaremill.diffx.DiffResultTransformer$$$Lambda$8607/0x0000000802447840@2e018fb4
// )
case class Person(name:String, age:Int)

Expand Down