Skip to content
This repository has been archived by the owner on Jan 24, 2025. It is now read-only.

Commit

Permalink
Release 0.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ghostbuster91 committed Oct 31, 2021
1 parent 23bf25a commit 2d76733
Show file tree
Hide file tree
Showing 8 changed files with 33 additions and 19 deletions.
4 changes: 2 additions & 2 deletions generated-docs/out/integrations/cats.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ This module contains integration layer between [org.typelevel.cats](https://gith
## sbt

```scala
"com.softwaremill.diffx" %% "diffx-cats" % "0.5.6" % Test
"com.softwaremill.diffx" %% "diffx-cats" % "0.6.0" % Test
```

## mill

```scala
ivy"com.softwaremill.diffx::diffx-cats::0.5.6"
ivy"com.softwaremill.diffx::diffx-cats::0.6.0"
```

## Usage
Expand Down
4 changes: 2 additions & 2 deletions generated-docs/out/integrations/refined.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ This module contains integration layer between [eu.timepit.refined](https://gith
## sbt

```scala
"com.softwaremill.diffx" %% "diffx-refined" % "0.5.6" % Test
"com.softwaremill.diffx" %% "diffx-refined" % "0.6.0" % Test
```

## mill

```scala
ivy"com.softwaremill.diffx::diffx-refined::0.5.6"
ivy"com.softwaremill.diffx::diffx-refined::0.6.0"
```

## Usage
Expand Down
4 changes: 2 additions & 2 deletions generated-docs/out/integrations/tagging.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ This module contains integration layer between [com.softwaremill.common.tagging]
## sbt

```scala
"com.softwaremill.diffx" %% "diffx-tagging" % "0.5.6"
"com.softwaremill.diffx" %% "diffx-tagging" % "0.6.0"
```

## mill

```scala
ivy"com.softwaremill.diffx::diffx-tagging::0.5.6"
ivy"com.softwaremill.diffx::diffx-tagging::0.6.0"
```

## Usage
Expand Down
4 changes: 2 additions & 2 deletions generated-docs/out/test-frameworks/munit.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ To use with munit, add following dependency:
## sbt

```scala
"com.softwaremill.diffx" %% "diffx-munit" % "0.5.6" % Test
"com.softwaremill.diffx" %% "diffx-munit" % "0.6.0" % Test
```

## mill

```scala
ivy"com.softwaremill.diffx::diffx-munit::0.5.6"
ivy"com.softwaremill.diffx::diffx-munit::0.6.0"
```

## Usage
Expand Down
26 changes: 20 additions & 6 deletions generated-docs/out/test-frameworks/scalatest.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,38 @@ To use with scalatest, add the following dependency:

## sbt

For use with `should` matchers:
```scala
"com.softwaremill.diffx" %% "diffx-scalatest" % "0.5.6" % Test
"com.softwaremill.diffx" %% "diffx-scalatest-should" % "0.6.0" % Test
```

For use with `must` matchers:
```scala
"com.softwaremill.diffx" %% "diffx-scalatest-should" % "0.6.0" % Test
```

## mill

For use with `should` matchers:
```scala
ivy"com.softwaremill.diffx::diffx-scalatest::0.5.6"
ivy"com.softwaremill.diffx::diffx-scalatest-must::0.6.0"
```

For use with `must` matchers:
```scala
ivy"com.softwaremill.diffx::diffx-scalatest-must::0.6.0"
```

## Usage

Then, extend the `com.softwaremill.diffx.scalatest.DiffMatcher` trait or `import com.softwaremill.diffx.scalatest.DiffMatcher._`.
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`

After that you will be able to use syntax such as:

```scala
import org.scalatest.matchers.should.Matchers._
import com.softwaremill.diffx.scalatest.DiffMatcher._
import com.softwaremill.diffx.scalatest.DiffShouldMatcher._
import com.softwaremill.diffx.generic.auto._

sealed trait Parent
Expand All @@ -40,5 +54,5 @@ val left: Foo = Foo(
Some(right)
)

left should matchTo(right)
left shouldMatchTo(right)
```
4 changes: 2 additions & 2 deletions generated-docs/out/test-frameworks/specs2.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ To use with specs2, add the following dependency:
## sbt

```scala
"com.softwaremill.diffx" %% "diffx-specs2" % "0.5.6" % Test
"com.softwaremill.diffx" %% "diffx-specs2" % "0.6.0" % Test
```

## mill

```scala
ivy"com.softwaremill.diffx::diffx-specs2::0.5.6"
ivy"com.softwaremill.diffx::diffx-specs2::0.6.0"
```

## Usage
Expand Down
4 changes: 2 additions & 2 deletions generated-docs/out/test-frameworks/utest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ To use with utest, add following dependency:
## sbt

```scala
"com.softwaremill.diffx" %% "diffx-utest" % "0.5.6" % Test
"com.softwaremill.diffx" %% "diffx-utest" % "0.6.0" % Test
```

## mill

```scala
ivy"com.softwaremill.diffx::diffx-utest::0.5.6"
ivy"com.softwaremill.diffx::diffx-utest::0.6.0"
```

## Usage
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@275c48e0
// d: Diff[Person] = com.softwaremill.diffx.Diff$$anon$1@2f232df9
d(Person("bob", 25), Person("bob", 30))
// res2: DiffResult = DiffResultObject(
// name = "Person",
Expand Down

0 comments on commit 2d76733

Please sign in to comment.