From 8d29e408da06e7842e7c349735836654def3ba51 Mon Sep 17 00:00:00 2001 From: ghostbuster91 Date: Sun, 24 Sep 2023 17:06:58 +0200 Subject: [PATCH 1/9] Update weaver documentation --- docs-sources/test-frameworks/weaver.md | 5 ++--- generated-docs/out/test-frameworks/weaver.md | 5 ++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/docs-sources/test-frameworks/weaver.md b/docs-sources/test-frameworks/weaver.md index 525a95f9..6a242e02 100644 --- a/docs-sources/test-frameworks/weaver.md +++ b/docs-sources/test-frameworks/weaver.md @@ -48,6 +48,5 @@ Below table shows past Diffx releases with the corresponding weaver version they For newer versions checkout the release changelog. | Diffx | weaver | -|-------|:------:| -| 0.8.4 | 0.8.3 | - +| ----- | :----: | +| 0.9.0 | 0.8.3 | diff --git a/generated-docs/out/test-frameworks/weaver.md b/generated-docs/out/test-frameworks/weaver.md index 272de1fa..88d4bec3 100644 --- a/generated-docs/out/test-frameworks/weaver.md +++ b/generated-docs/out/test-frameworks/weaver.md @@ -48,6 +48,5 @@ Below table shows past Diffx releases with the corresponding weaver version they For newer versions checkout the release changelog. | Diffx | weaver | -|-------|:------:| -| 0.8.4 | 0.8.3 | - +| ----- | :----: | +| 0.9.0 | 0.8.3 | From f87b84122a1ff3f8e24affa388c0ecb7800a33f1 Mon Sep 17 00:00:00 2001 From: ghostbuster91 Date: Sun, 24 Sep 2023 17:08:17 +0200 Subject: [PATCH 2/9] Add weaver to documentation index --- docs-sources/index.md | 1 + generated-docs/out/index.md | 1 + 2 files changed, 2 insertions(+) diff --git a/docs-sources/index.md b/docs-sources/index.md index 967cbb01..e5ac4c38 100644 --- a/docs-sources/index.md +++ b/docs-sources/index.md @@ -77,6 +77,7 @@ a software development and consulting company. We help clients scale their busin test-frameworks/specs2 test-frameworks/utest test-frameworks/munit + test-frameworks/weaver test-frameworks/summary .. toctree:: diff --git a/generated-docs/out/index.md b/generated-docs/out/index.md index 194c0a62..5ac0008e 100644 --- a/generated-docs/out/index.md +++ b/generated-docs/out/index.md @@ -116,6 +116,7 @@ a software development and consulting company. We help clients scale their busin test-frameworks/specs2 test-frameworks/utest test-frameworks/munit + test-frameworks/weaver test-frameworks/summary .. toctree:: From bd6facad0dd1c6d753bf7b8ad5b3f9710d39a0dd Mon Sep 17 00:00:00 2001 From: Kasper Kondzielski Date: Sun, 24 Sep 2023 19:20:12 +0200 Subject: [PATCH 3/9] Add CI step to check if sources are formatted correctly (#453) * Add CI step to check if sources are formatted correctly * Format sources --------- Co-authored-by: ghostbuster91 --- .github/workflows/main.yaml | 18 ++++++++++++ .../diffx/DiffResultPrinter.scala | 29 ++++++++++--------- .../diffx/test/DiffResultTest.scala | 2 +- .../softwaremill/diffx/test/examples.scala | 2 +- 4 files changed, 35 insertions(+), 16 deletions(-) diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml index f6643e0d..ff234df5 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/main.yaml @@ -68,6 +68,24 @@ jobs: - name: Check MiMa run: sbt $SBT_JAVA_OPTS -v mimaReportBinaryIssues + check-formatting: + # run on external PRs, but not on internal PRs since those will be run by push to branch + if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository + runs-on: ubuntu-22.04 + steps: + - name: Checkout + uses: actions/checkout@v3 + with: + fetch-depth: 0 # checkout tags so that dynver works properly (we need the version for MiMa) + - name: Set up JDK 11 + uses: actions/setup-java@v3 + with: + distribution: "temurin" + java-version: 11 + cache: "sbt" + - name: Check formatting + run: sbt $SBT_JAVA_OPTS -v scalafmtCheckAll + publish: name: Publish release if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v')) diff --git a/core/src/main/scala/com/softwaremill/diffx/DiffResultPrinter.scala b/core/src/main/scala/com/softwaremill/diffx/DiffResultPrinter.scala index b33ef3cb..95607c1b 100644 --- a/core/src/main/scala/com/softwaremill/diffx/DiffResultPrinter.scala +++ b/core/src/main/scala/com/softwaremill/diffx/DiffResultPrinter.scala @@ -5,19 +5,19 @@ object DiffResultPrinter { def showIndented(diffResult: DiffResult, indent: Int)(implicit sc: ShowConfig): String = { diffResult match { - case dr: DiffResultObject => showDiffResultObject(dr, indent) - case dr: DiffResultIterable => showDiffResultIterable(dr, indent) - case dr: DiffResultMap => showDiffResultMap(dr, indent) - case dr: DiffResultSet => showDiffResultSet(dr, indent) - case dr: DiffResultString => s"${dr.diffs.map(ds => showIndented(ds, indent)).mkString("\n")}" - case dr: DiffResultStringLine => mergeChunks(dr.diffs).map(ds => showIndented(ds, indent)).mkString - case dr: DiffResultStringWord => mergeChunks(dr.diffs).map(ds => showIndented(ds, indent)).mkString - case dr: DiffResultChunk => arrowColor("[") + showChange(s"${dr.left}", s"${dr.right}", indent) + arrowColor("]") - case dr: DiffResultValue[_] => showChange(s"${dr.left}", s"${dr.right}", indent) - case dr: IdenticalValue[_] => defaultColor(s"${dr.value}", indent) - case dr: DiffResultMissing[_] => missingColor(s"${dr.value}", indent) - case dr: DiffResultMissingChunk => missingColor(s"[${dr.value}]", indent) - case dr: DiffResultAdditional[_] => additionalColor(s"${dr.value}", indent) + case dr: DiffResultObject => showDiffResultObject(dr, indent) + case dr: DiffResultIterable => showDiffResultIterable(dr, indent) + case dr: DiffResultMap => showDiffResultMap(dr, indent) + case dr: DiffResultSet => showDiffResultSet(dr, indent) + case dr: DiffResultString => s"${dr.diffs.map(ds => showIndented(ds, indent)).mkString("\n")}" + case dr: DiffResultStringLine => mergeChunks(dr.diffs).map(ds => showIndented(ds, indent)).mkString + case dr: DiffResultStringWord => mergeChunks(dr.diffs).map(ds => showIndented(ds, indent)).mkString + case dr: DiffResultChunk => arrowColor("[") + showChange(s"${dr.left}", s"${dr.right}", indent) + arrowColor("]") + case dr: DiffResultValue[_] => showChange(s"${dr.left}", s"${dr.right}", indent) + case dr: IdenticalValue[_] => defaultColor(s"${dr.value}", indent) + case dr: DiffResultMissing[_] => missingColor(s"${dr.value}", indent) + case dr: DiffResultMissingChunk => missingColor(s"[${dr.value}]", indent) + case dr: DiffResultAdditional[_] => additionalColor(s"${dr.value}", indent) case dr: DiffResultAdditionalChunk => additionalColor(s"[${dr.value}]", indent) } } @@ -90,7 +90,8 @@ object DiffResultPrinter { } private def missingColor(s: String, indent: Int)(implicit c: ShowConfig): String = withColor(s, c.missing, indent) - private def additionalColor(s: String, indent: Int)(implicit c: ShowConfig): String = withColor(s, c.additional, indent) + private def additionalColor(s: String, indent: Int)(implicit c: ShowConfig): String = + withColor(s, c.additional, indent) private def defaultColor(s: String, indent: Int = 0)(implicit c: ShowConfig): String = withColor(s, c.default, indent) private def arrowColor(s: String)(implicit c: ShowConfig): String = c.arrow(s) private def showChange(l: String, r: String, indent: Int)(implicit c: ShowConfig): String = diff --git a/core/src/test/scala/com/softwaremill/diffx/test/DiffResultTest.scala b/core/src/test/scala/com/softwaremill/diffx/test/DiffResultTest.scala index a1675308..ce0a9bdf 100644 --- a/core/src/test/scala/com/softwaremill/diffx/test/DiffResultTest.scala +++ b/core/src/test/scala/com/softwaremill/diffx/test/DiffResultTest.scala @@ -179,7 +179,7 @@ class DiffResultTest extends AnyFreeSpec with Matchers { Map( "0" -> IdenticalValue(john), "1" -> DiffResultAdditional(mary), - "2" -> DiffResultMissing(jane), + "2" -> DiffResultMissing(jane) ) ).show() shouldBe """List( diff --git a/core/src/test/scala/com/softwaremill/diffx/test/examples.scala b/core/src/test/scala/com/softwaremill/diffx/test/examples.scala index 9be914a2..92e85b49 100644 --- a/core/src/test/scala/com/softwaremill/diffx/test/examples.scala +++ b/core/src/test/scala/com/softwaremill/diffx/test/examples.scala @@ -67,6 +67,6 @@ class VerboseNonCaseClass(private val key: String, private val value: Int) { override def equals(obj: Any): Boolean = obj match { case other: VerboseNonCaseClass => other.key == key && other.value == value - case _ => false + case _ => false } } From 5efbfacc27815cd932c27e82aa55225cd7469d0d Mon Sep 17 00:00:00 2001 From: Kasper Kondzielski Date: Sun, 24 Sep 2023 19:20:26 +0200 Subject: [PATCH 4/9] Fix readthedocs (#452) --- .readthedocs.yaml | 16 ++- README.md | 2 +- docs-sources/conf.py | 10 +- docs-sources/flake.lock | 128 +++++++++++++++++++++ docs-sources/flake.nix | 54 +++++++++ docs-sources/requirements.pip | 4 - docs-sources/requirements.txt | 5 + docs-sources/watch.sh | 2 - generated-docs/out/conf.py | 10 +- generated-docs/out/flake.lock | 128 +++++++++++++++++++++ generated-docs/out/flake.nix | 54 +++++++++ generated-docs/out/integrations/cats.md | 4 +- generated-docs/out/integrations/refined.md | 4 +- generated-docs/out/integrations/tagging.md | 2 +- generated-docs/out/requirements.pip | 4 - generated-docs/out/requirements.txt | 5 + generated-docs/out/usage/ignoring.md | 2 +- generated-docs/out/usage/output.md | 14 +-- generated-docs/out/watch.sh | 2 - 19 files changed, 411 insertions(+), 39 deletions(-) create mode 100644 docs-sources/flake.lock create mode 100644 docs-sources/flake.nix delete mode 100644 docs-sources/requirements.pip create mode 100644 docs-sources/requirements.txt delete mode 100755 docs-sources/watch.sh create mode 100644 generated-docs/out/flake.lock create mode 100644 generated-docs/out/flake.nix delete mode 100644 generated-docs/out/requirements.pip create mode 100644 generated-docs/out/requirements.txt delete mode 100755 generated-docs/out/watch.sh diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 4d0de76a..52030312 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -2,10 +2,16 @@ version: 2 sphinx: - configuration: generated-docs/out/conf.py + configuration: generated-docs/out/conf.py -# Optionally set the version of Python and requirements required to build your docs python: - version: 3.7 - install: - - requirements: generated-docs/out/requirements.pip \ No newline at end of file + install: + - requirements: generated-docs/out/requirements.txt + +build: + os: ubuntu-22.04 + tools: + python: "3.7" + nodejs: "18" # not sure if needed but better to fix its version + rust: "1.64" # not sure if needed but better to fix its version + golang: "1.19" # not sure if needed but better to fix its version diff --git a/README.md b/README.md index f14aaccb..910e52d1 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ [![Gitter](https://badges.gitter.im/softwaremill/diffx.svg)](https://gitter.im/softwaremill/diffx?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) -[![Mergify Status](https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/softwaremill/diffx&style=flat)](https://mergify.io) [![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-brightgreen.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org) +[![Documentation Status](https://readthedocs.org/projects/diffx-scala/badge/?version=latest)](https://diffx-scala.readthedocs.io/en/latest/?badge=latest) ## Documentation diff --git a/docs-sources/conf.py b/docs-sources/conf.py index 53a552c9..540d5539 100644 --- a/docs-sources/conf.py +++ b/docs-sources/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# sttp documentation build configuration file, created by +# diffx documentation build configuration file, created by # sphinx-quickstart on Thu Oct 12 15:51:09 2017. # # This file is execfile()d with the current directory set to its @@ -42,7 +42,7 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = ['myst_parser', 'sphinx_rtd_theme'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -54,8 +54,10 @@ from recommonmark.parser import CommonMarkParser from recommonmark.transform import AutoStructify -source_parsers = { - '.md': CommonMarkParser, +source_suffix = { + '.rst': 'restructuredtext', + '.txt': 'markdown', + '.md': 'markdown', } source_suffix = ['.rst', '.md'] diff --git a/docs-sources/flake.lock b/docs-sources/flake.lock new file mode 100644 index 00000000..ec82605a --- /dev/null +++ b/docs-sources/flake.lock @@ -0,0 +1,128 @@ +{ + "nodes": { + "flake-utils": { + "inputs": { + "systems": "systems" + }, + "locked": { + "lastModified": 1694529238, + "narHash": "sha256-zsNZZGTGnMOf9YpHKJqMSsa0dXbfmxeoJ7xHlrt+xmY=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "ff7b65b44d01cf9ba6a71320833626af21126384", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "flake-utils_2": { + "locked": { + "lastModified": 1642700792, + "narHash": "sha256-XqHrk7hFb+zBvRg6Ghl+AZDq03ov6OshJLiSWOoX5es=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "846b2ae0fc4cc943637d3d1def4454213e203cba", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "mach-nix": { + "inputs": { + "flake-utils": "flake-utils_2", + "nixpkgs": "nixpkgs", + "pypi-deps-db": "pypi-deps-db" + }, + "locked": { + "lastModified": 1694857725, + "narHash": "sha256-Ob4gMVo5uiSRhdDAD6k85jy5ys7dbc/KC4DPdSZm9Rc=", + "owner": "davhau", + "repo": "mach-nix", + "rev": "0fb2c80ad2a74261315939849e1e8bf4278b7178", + "type": "github" + }, + "original": { + "owner": "davhau", + "repo": "mach-nix", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1643805626, + "narHash": "sha256-AXLDVMG+UaAGsGSpOtQHPIKB+IZ0KSd9WS77aanGzgc=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "554d2d8aa25b6e583575459c297ec23750adb6cb", + "type": "github" + }, + "original": { + "id": "nixpkgs", + "ref": "nixos-unstable", + "type": "indirect" + } + }, + "nixpkgs_2": { + "locked": { + "lastModified": 1695360818, + "narHash": "sha256-JlkN3R/SSoMTa+CasbxS1gq+GpGxXQlNZRUh9+LIy/0=", + "owner": "nixos", + "repo": "nixpkgs", + "rev": "e35dcc04a3853da485a396bdd332217d0ac9054f", + "type": "github" + }, + "original": { + "owner": "nixos", + "ref": "nixos-unstable", + "repo": "nixpkgs", + "type": "github" + } + }, + "pypi-deps-db": { + "flake": false, + "locked": { + "lastModified": 1685526402, + "narHash": "sha256-V0SXx0dWlUBL3E/wHWTszrkK2dOnuYYnBc7n6e0+NQU=", + "owner": "DavHau", + "repo": "pypi-deps-db", + "rev": "ba35683c35218acb5258b69a9916994979dc73a9", + "type": "github" + }, + "original": { + "owner": "DavHau", + "repo": "pypi-deps-db", + "type": "github" + } + }, + "root": { + "inputs": { + "flake-utils": "flake-utils", + "mach-nix": "mach-nix", + "nixpkgs": "nixpkgs_2" + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/docs-sources/flake.nix b/docs-sources/flake.nix new file mode 100644 index 00000000..071feb85 --- /dev/null +++ b/docs-sources/flake.nix @@ -0,0 +1,54 @@ +{ + description = "Python shell flake"; + + inputs = { + nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable"; + flake-utils.url = "github:numtide/flake-utils"; + + mach-nix.url = "github:davhau/mach-nix"; + }; + + outputs = { self, nixpkgs, mach-nix, flake-utils, ... }: + let + pythonVersion = "python37"; + in + flake-utils.lib.eachDefaultSystem (system: + let + pkgs = nixpkgs.legacyPackages.${system}; + mach = mach-nix.lib.${system}; + + pythonEnv = mach.mkPython { + python = pythonVersion; + requirements = builtins.readFile ./requirements.txt; + }; + watchDocs = + let + name = "watchDocs"; + src = pkgs.writeShellScript name '' + sphinx-autobuild . _build/html + ''; + in + pkgs.stdenv.mkDerivation + { + inherit name src; + + phases = [ "installPhase" "patchPhase" ]; + + installPhase = '' + mkdir -p $out/bin + cp $src $out/bin/${name} + chmod +x $out/bin/${name} + ''; + }; + in + { + devShells.default = pkgs.mkShellNoCC { + packages = [ pythonEnv watchDocs ]; + + shellHook = '' + export PYTHONPATH="${pythonEnv}/bin/python" + ''; + }; + } + ); +} diff --git a/docs-sources/requirements.pip b/docs-sources/requirements.pip deleted file mode 100644 index cb4b2b97..00000000 --- a/docs-sources/requirements.pip +++ /dev/null @@ -1,4 +0,0 @@ -sphinx_rtd_theme==0.4.3 -recommonmark==0.5.0 -sphinx==2.0.1 -sphinx-autobuild==0.7.1 diff --git a/docs-sources/requirements.txt b/docs-sources/requirements.txt new file mode 100644 index 00000000..23be225b --- /dev/null +++ b/docs-sources/requirements.txt @@ -0,0 +1,5 @@ +sphinx_rtd_theme==1.0.0 +recommonmark==0.7.1 +sphinx==4.2.0 +sphinx-autobuild==2021.3.14 +myst-parser==0.15.2 diff --git a/docs-sources/watch.sh b/docs-sources/watch.sh deleted file mode 100755 index 24c43727..00000000 --- a/docs-sources/watch.sh +++ /dev/null @@ -1,2 +0,0 @@ -#!/bin/bash -sphinx-autobuild . _build/html diff --git a/generated-docs/out/conf.py b/generated-docs/out/conf.py index 53a552c9..540d5539 100644 --- a/generated-docs/out/conf.py +++ b/generated-docs/out/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# sttp documentation build configuration file, created by +# diffx documentation build configuration file, created by # sphinx-quickstart on Thu Oct 12 15:51:09 2017. # # This file is execfile()d with the current directory set to its @@ -42,7 +42,7 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = ['myst_parser', 'sphinx_rtd_theme'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -54,8 +54,10 @@ from recommonmark.parser import CommonMarkParser from recommonmark.transform import AutoStructify -source_parsers = { - '.md': CommonMarkParser, +source_suffix = { + '.rst': 'restructuredtext', + '.txt': 'markdown', + '.md': 'markdown', } source_suffix = ['.rst', '.md'] diff --git a/generated-docs/out/flake.lock b/generated-docs/out/flake.lock new file mode 100644 index 00000000..ec82605a --- /dev/null +++ b/generated-docs/out/flake.lock @@ -0,0 +1,128 @@ +{ + "nodes": { + "flake-utils": { + "inputs": { + "systems": "systems" + }, + "locked": { + "lastModified": 1694529238, + "narHash": "sha256-zsNZZGTGnMOf9YpHKJqMSsa0dXbfmxeoJ7xHlrt+xmY=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "ff7b65b44d01cf9ba6a71320833626af21126384", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "flake-utils_2": { + "locked": { + "lastModified": 1642700792, + "narHash": "sha256-XqHrk7hFb+zBvRg6Ghl+AZDq03ov6OshJLiSWOoX5es=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "846b2ae0fc4cc943637d3d1def4454213e203cba", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "mach-nix": { + "inputs": { + "flake-utils": "flake-utils_2", + "nixpkgs": "nixpkgs", + "pypi-deps-db": "pypi-deps-db" + }, + "locked": { + "lastModified": 1694857725, + "narHash": "sha256-Ob4gMVo5uiSRhdDAD6k85jy5ys7dbc/KC4DPdSZm9Rc=", + "owner": "davhau", + "repo": "mach-nix", + "rev": "0fb2c80ad2a74261315939849e1e8bf4278b7178", + "type": "github" + }, + "original": { + "owner": "davhau", + "repo": "mach-nix", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1643805626, + "narHash": "sha256-AXLDVMG+UaAGsGSpOtQHPIKB+IZ0KSd9WS77aanGzgc=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "554d2d8aa25b6e583575459c297ec23750adb6cb", + "type": "github" + }, + "original": { + "id": "nixpkgs", + "ref": "nixos-unstable", + "type": "indirect" + } + }, + "nixpkgs_2": { + "locked": { + "lastModified": 1695360818, + "narHash": "sha256-JlkN3R/SSoMTa+CasbxS1gq+GpGxXQlNZRUh9+LIy/0=", + "owner": "nixos", + "repo": "nixpkgs", + "rev": "e35dcc04a3853da485a396bdd332217d0ac9054f", + "type": "github" + }, + "original": { + "owner": "nixos", + "ref": "nixos-unstable", + "repo": "nixpkgs", + "type": "github" + } + }, + "pypi-deps-db": { + "flake": false, + "locked": { + "lastModified": 1685526402, + "narHash": "sha256-V0SXx0dWlUBL3E/wHWTszrkK2dOnuYYnBc7n6e0+NQU=", + "owner": "DavHau", + "repo": "pypi-deps-db", + "rev": "ba35683c35218acb5258b69a9916994979dc73a9", + "type": "github" + }, + "original": { + "owner": "DavHau", + "repo": "pypi-deps-db", + "type": "github" + } + }, + "root": { + "inputs": { + "flake-utils": "flake-utils", + "mach-nix": "mach-nix", + "nixpkgs": "nixpkgs_2" + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/generated-docs/out/flake.nix b/generated-docs/out/flake.nix new file mode 100644 index 00000000..071feb85 --- /dev/null +++ b/generated-docs/out/flake.nix @@ -0,0 +1,54 @@ +{ + description = "Python shell flake"; + + inputs = { + nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable"; + flake-utils.url = "github:numtide/flake-utils"; + + mach-nix.url = "github:davhau/mach-nix"; + }; + + outputs = { self, nixpkgs, mach-nix, flake-utils, ... }: + let + pythonVersion = "python37"; + in + flake-utils.lib.eachDefaultSystem (system: + let + pkgs = nixpkgs.legacyPackages.${system}; + mach = mach-nix.lib.${system}; + + pythonEnv = mach.mkPython { + python = pythonVersion; + requirements = builtins.readFile ./requirements.txt; + }; + watchDocs = + let + name = "watchDocs"; + src = pkgs.writeShellScript name '' + sphinx-autobuild . _build/html + ''; + in + pkgs.stdenv.mkDerivation + { + inherit name src; + + phases = [ "installPhase" "patchPhase" ]; + + installPhase = '' + mkdir -p $out/bin + cp $src $out/bin/${name} + chmod +x $out/bin/${name} + ''; + }; + in + { + devShells.default = pkgs.mkShellNoCC { + packages = [ pythonEnv watchDocs ]; + + shellHook = '' + export PYTHONPATH="${pythonEnv}/bin/python" + ''; + }; + } + ); +} diff --git a/generated-docs/out/integrations/cats.md b/generated-docs/out/integrations/cats.md index d467696b..b705ef7d 100644 --- a/generated-docs/out/integrations/cats.md +++ b/generated-docs/out/integrations/cats.md @@ -5,7 +5,7 @@ This module contains integration layer between [org.typelevel.cats](https://gith ## sbt ```scala -"com.softwaremill.diffx" %% "diffx-cats" % "0.9.0" % Test +"com.softwaremill.diffx" %% "diffx-cats" % "0.9.0" % Test ``` ## mill @@ -50,4 +50,4 @@ compare(t1, t2) // ) // ) // ) -``` \ No newline at end of file +``` diff --git a/generated-docs/out/integrations/refined.md b/generated-docs/out/integrations/refined.md index 959c3dcf..e8eeb3ee 100644 --- a/generated-docs/out/integrations/refined.md +++ b/generated-docs/out/integrations/refined.md @@ -5,7 +5,7 @@ This module contains integration layer between [eu.timepit.refined](https://gith ## sbt ```scala -"com.softwaremill.diffx" %% "diffx-refined" % "0.9.0" % Test +"com.softwaremill.diffx" %% "diffx-refined" % "0.9.0" % Test ``` ## mill @@ -50,4 +50,4 @@ compare(t1, t2) // ) // ) // ) -``` \ No newline at end of file +``` diff --git a/generated-docs/out/integrations/tagging.md b/generated-docs/out/integrations/tagging.md index b692887d..7f22c8b3 100644 --- a/generated-docs/out/integrations/tagging.md +++ b/generated-docs/out/integrations/tagging.md @@ -43,4 +43,4 @@ compare(t1, t2) // "p2" -> DiffResultValue(left = 1, right = 3) // ) // ) -``` \ No newline at end of file +``` diff --git a/generated-docs/out/requirements.pip b/generated-docs/out/requirements.pip deleted file mode 100644 index cb4b2b97..00000000 --- a/generated-docs/out/requirements.pip +++ /dev/null @@ -1,4 +0,0 @@ -sphinx_rtd_theme==0.4.3 -recommonmark==0.5.0 -sphinx==2.0.1 -sphinx-autobuild==0.7.1 diff --git a/generated-docs/out/requirements.txt b/generated-docs/out/requirements.txt new file mode 100644 index 00000000..23be225b --- /dev/null +++ b/generated-docs/out/requirements.txt @@ -0,0 +1,5 @@ +sphinx_rtd_theme==1.0.0 +recommonmark==0.7.1 +sphinx==4.2.0 +sphinx-autobuild==2021.3.14 +myst-parser==0.15.2 diff --git a/generated-docs/out/usage/ignoring.md b/generated-docs/out/usage/ignoring.md index 02d84a26..5b691a83 100644 --- a/generated-docs/out/usage/ignoring.md +++ b/generated-docs/out/usage/ignoring.md @@ -44,7 +44,7 @@ implicit val conf: DiffConfiguration = DiffConfiguration(makeIgnored = ) // conf: DiffConfiguration = DiffConfiguration(makeIgnored = ) val d = Diff[Person].ignore(_.age) -// d: Diff[Person] = com.softwaremill.diffx.Diff$$anon$1@15be0d90 +// d: Diff[Person] = com.softwaremill.diffx.Diff$$anon$1@32c068ef d(Person("bob", 25), Person("bob", 30)) // res2: DiffResult = DiffResultObject( // name = "Person", diff --git a/generated-docs/out/usage/output.md b/generated-docs/out/usage/output.md index 8ec18179..824d0ac6 100644 --- a/generated-docs/out/usage/output.md +++ b/generated-docs/out/usage/output.md @@ -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$11343/0x000000080299f5d0@12b00fa1, -// right = com.softwaremill.diffx.ShowConfig$$$Lambda$11343/0x000000080299f5d0@2dd6b795, -// missing = com.softwaremill.diffx.ShowConfig$$$Lambda$11343/0x000000080299f5d0@6e405457, -// additional = com.softwaremill.diffx.ShowConfig$$$Lambda$11343/0x000000080299f5d0@25710eff, -// default = com.softwaremill.diffx.ShowConfig$$$Lambda$11346/0x00000008029a4000@372ec0f7, -// arrow = com.softwaremill.diffx.ShowConfig$$$Lambda$11343/0x000000080299f5d0@2fdca398, -// transformer = com.softwaremill.diffx.DiffResultTransformer$$$Lambda$11335/0x000000080299d5a8@43d2a8d8 +// 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 // ) case class Person(name:String, age:Int) diff --git a/generated-docs/out/watch.sh b/generated-docs/out/watch.sh deleted file mode 100755 index 24c43727..00000000 --- a/generated-docs/out/watch.sh +++ /dev/null @@ -1,2 +0,0 @@ -#!/bin/bash -sphinx-autobuild . _build/html From 3c66a6e0dcb600a277ed75cdd00840d262033809 Mon Sep 17 00:00:00 2001 From: Dario Abdulrehman <167463+dabd@users.noreply.github.com> Date: Mon, 25 Sep 2023 20:02:50 +0100 Subject: [PATCH 5/9] Fix incorrect weaver groupId in docs (#454) Co-authored-by: Dario Abdulrehman --- docs-sources/integrations/cats.md | 5 +++-- docs-sources/integrations/refined.md | 4 ++-- docs-sources/integrations/tagging.md | 4 ++-- docs-sources/test-frameworks/munit.md | 19 +++++++++---------- docs-sources/test-frameworks/scalatest.md | 8 ++++++-- docs-sources/test-frameworks/specs2.md | 3 +-- docs-sources/test-frameworks/utest.md | 3 +-- docs-sources/test-frameworks/weaver.md | 2 +- generated-docs/out/integrations/cats.md | 1 + generated-docs/out/integrations/tagging.md | 2 +- generated-docs/out/test-frameworks/munit.md | 19 +++++++++---------- .../out/test-frameworks/scalatest.md | 8 ++++++-- generated-docs/out/test-frameworks/specs2.md | 3 +-- generated-docs/out/test-frameworks/utest.md | 3 +-- generated-docs/out/test-frameworks/weaver.md | 2 +- generated-docs/out/usage/ignoring.md | 2 +- generated-docs/out/usage/output.md | 14 +++++++------- 17 files changed, 53 insertions(+), 49 deletions(-) diff --git a/docs-sources/integrations/cats.md b/docs-sources/integrations/cats.md index 93b44157..e9fa89d8 100644 --- a/docs-sources/integrations/cats.md +++ b/docs-sources/integrations/cats.md @@ -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 @@ -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]) @@ -33,4 +34,4 @@ import com.softwaremill.diffx.generic.auto._ import com.softwaremill.diffx.cats._ compare(t1, t2) -``` \ No newline at end of file +``` diff --git a/docs-sources/integrations/refined.md b/docs-sources/integrations/refined.md index cf4ad830..2bb97b65 100644 --- a/docs-sources/integrations/refined.md +++ b/docs-sources/integrations/refined.md @@ -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 @@ -37,4 +37,4 @@ import com.softwaremill.diffx.generic.auto._ import com.softwaremill.diffx.refined._ compare(t1, t2) -``` \ No newline at end of file +``` diff --git a/docs-sources/integrations/tagging.md b/docs-sources/integrations/tagging.md index f64f7767..ce8fc3f5 100644 --- a/docs-sources/integrations/tagging.md +++ b/docs-sources/integrations/tagging.md @@ -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@" @@ -36,4 +36,4 @@ import com.softwaremill.diffx.generic.auto._ import com.softwaremill.diffx.tagging._ compare(t1, t2) -``` \ No newline at end of file +``` diff --git a/docs-sources/test-frameworks/munit.md b/docs-sources/test-frameworks/munit.md index 7f8d557f..bab469de 100644 --- a/docs-sources/test-frameworks/munit.md +++ b/docs-sources/test-frameworks/munit.md @@ -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 | diff --git a/docs-sources/test-frameworks/scalatest.md b/docs-sources/test-frameworks/scalatest.md index deefef53..11fce4d4 100644 --- a/docs-sources/test-frameworks/scalatest.md +++ b/docs-sources/test-frameworks/scalatest.md @@ -5,11 +5,13 @@ 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 ``` @@ -17,11 +19,13 @@ For use with `must` matchers: ## 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@" ``` @@ -29,6 +33,7 @@ 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` @@ -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 | @@ -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 | - diff --git a/docs-sources/test-frameworks/specs2.md b/docs-sources/test-frameworks/specs2.md index cad7e7ab..d8de63b1 100644 --- a/docs-sources/test-frameworks/specs2.md +++ b/docs-sources/test-frameworks/specs2.md @@ -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 | @@ -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 | - diff --git a/docs-sources/test-frameworks/utest.md b/docs-sources/test-frameworks/utest.md index ac9ab69c..11c08e8d 100644 --- a/docs-sources/test-frameworks/utest.md +++ b/docs-sources/test-frameworks/utest.md @@ -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 | @@ -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 | - diff --git a/docs-sources/test-frameworks/weaver.md b/docs-sources/test-frameworks/weaver.md index 6a242e02..e1117360 100644 --- a/docs-sources/test-frameworks/weaver.md +++ b/docs-sources/test-frameworks/weaver.md @@ -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 diff --git a/generated-docs/out/integrations/cats.md b/generated-docs/out/integrations/cats.md index b705ef7d..b9533113 100644 --- a/generated-docs/out/integrations/cats.md +++ b/generated-docs/out/integrations/cats.md @@ -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]) diff --git a/generated-docs/out/integrations/tagging.md b/generated-docs/out/integrations/tagging.md index 7f22c8b3..b0001bd9 100644 --- a/generated-docs/out/integrations/tagging.md +++ b/generated-docs/out/integrations/tagging.md @@ -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" diff --git a/generated-docs/out/test-frameworks/munit.md b/generated-docs/out/test-frameworks/munit.md index b2374a74..2614d6f8 100644 --- a/generated-docs/out/test-frameworks/munit.md +++ b/generated-docs/out/test-frameworks/munit.md @@ -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 | diff --git a/generated-docs/out/test-frameworks/scalatest.md b/generated-docs/out/test-frameworks/scalatest.md index 6e66d8a6..3f0ee331 100644 --- a/generated-docs/out/test-frameworks/scalatest.md +++ b/generated-docs/out/test-frameworks/scalatest.md @@ -5,11 +5,13 @@ 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 ``` @@ -17,11 +19,13 @@ For use with `must` matchers: ## 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" ``` @@ -29,6 +33,7 @@ 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` @@ -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 | @@ -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 | - diff --git a/generated-docs/out/test-frameworks/specs2.md b/generated-docs/out/test-frameworks/specs2.md index 672038fa..ceef73f7 100644 --- a/generated-docs/out/test-frameworks/specs2.md +++ b/generated-docs/out/test-frameworks/specs2.md @@ -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 | @@ -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 | - diff --git a/generated-docs/out/test-frameworks/utest.md b/generated-docs/out/test-frameworks/utest.md index b989f8e4..0c16beee 100644 --- a/generated-docs/out/test-frameworks/utest.md +++ b/generated-docs/out/test-frameworks/utest.md @@ -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 | @@ -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 | - diff --git a/generated-docs/out/test-frameworks/weaver.md b/generated-docs/out/test-frameworks/weaver.md index 88d4bec3..c45cce02 100644 --- a/generated-docs/out/test-frameworks/weaver.md +++ b/generated-docs/out/test-frameworks/weaver.md @@ -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 diff --git a/generated-docs/out/usage/ignoring.md b/generated-docs/out/usage/ignoring.md index 5b691a83..62ffb2c7 100644 --- a/generated-docs/out/usage/ignoring.md +++ b/generated-docs/out/usage/ignoring.md @@ -44,7 +44,7 @@ implicit val conf: DiffConfiguration = DiffConfiguration(makeIgnored = ) // conf: DiffConfiguration = DiffConfiguration(makeIgnored = ) 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", diff --git a/generated-docs/out/usage/output.md b/generated-docs/out/usage/output.md index 824d0ac6..11d27295 100644 --- a/generated-docs/out/usage/output.md +++ b/generated-docs/out/usage/output.md @@ -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) From 9445f4578da46d74102e0e9b6334e71b104579c1 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 26 Sep 2023 11:42:00 +0200 Subject: [PATCH 6/9] Bump actions/checkout from 3 to 4 (#455) Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/main.yaml | 8 ++++---- .github/workflows/scala-steward.yml | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml index ff234df5..dcbbd39c 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/main.yaml @@ -20,7 +20,7 @@ jobs: scala-version: ["2.12", "2.13", "3"] target-platform: ["JVM", "JS"] steps: - - uses: actions/checkout@v3.5.3 + - uses: actions/checkout@v4 - uses: coursier/cache-action@v6.4 - name: Set up JDK 11 uses: actions/setup-java@v3 @@ -56,7 +56,7 @@ jobs: runs-on: ubuntu-22.04 steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 # checkout tags so that dynver works properly (we need the version for MiMa) - name: Set up JDK 11 @@ -74,7 +74,7 @@ jobs: runs-on: ubuntu-22.04 steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 # checkout tags so that dynver works properly (we need the version for MiMa) - name: Set up JDK 11 @@ -92,7 +92,7 @@ jobs: needs: [build] runs-on: ubuntu-22.04 steps: - - uses: actions/checkout@v3.5.3 + - uses: actions/checkout@v4 with: fetch-depth: 0 - uses: coursier/cache-action@v6.4 diff --git a/.github/workflows/scala-steward.yml b/.github/workflows/scala-steward.yml index 4f3ba2ca..69382c80 100644 --- a/.github/workflows/scala-steward.yml +++ b/.github/workflows/scala-steward.yml @@ -12,7 +12,7 @@ jobs: runs-on: ubuntu-20.04 steps: - name: Checkout - uses: actions/checkout@v3.5.3 + uses: actions/checkout@v4 - name: Set up JDK 11 uses: actions/setup-java@v3 with: From 034fd3670a27900189fba02188aa1a3680fda8ac Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 26 Sep 2023 11:42:11 +0200 Subject: [PATCH 7/9] Bump coursier/setup-action from 1.3.3 to 1.3.4 (#456) Bumps [coursier/setup-action](https://github.com/coursier/setup-action) from 1.3.3 to 1.3.4. - [Release notes](https://github.com/coursier/setup-action/releases) - [Commits](https://github.com/coursier/setup-action/compare/v1.3.3...v1.3.4) --- updated-dependencies: - dependency-name: coursier/setup-action dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/main.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml index dcbbd39c..bea52c44 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/main.yaml @@ -28,7 +28,7 @@ jobs: distribution: "temurin" cache: "sbt" java-version: 11 - - uses: coursier/setup-action@v1.3.3 + - uses: coursier/setup-action@v1.3.4 - name: Compile run: sbt $SBT_JAVA_OPTS -v "compileScoped ${{ matrix.scala-version }} ${{ matrix.target-platform }}" - name: Compile docs From b72d62c20080afdfa7349470093d791721d5eddc Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 10 Apr 2024 21:55:24 +0200 Subject: [PATCH 8/9] Bump actions/setup-java from 3 to 4 (#457) Bumps [actions/setup-java](https://github.com/actions/setup-java) from 3 to 4. - [Release notes](https://github.com/actions/setup-java/releases) - [Commits](https://github.com/actions/setup-java/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/setup-java dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/main.yaml | 8 ++++---- .github/workflows/scala-steward.yml | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml index bea52c44..92eeb77b 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/main.yaml @@ -23,7 +23,7 @@ jobs: - uses: actions/checkout@v4 - uses: coursier/cache-action@v6.4 - name: Set up JDK 11 - uses: actions/setup-java@v3 + uses: actions/setup-java@v4 with: distribution: "temurin" cache: "sbt" @@ -60,7 +60,7 @@ jobs: with: fetch-depth: 0 # checkout tags so that dynver works properly (we need the version for MiMa) - name: Set up JDK 11 - uses: actions/setup-java@v3 + uses: actions/setup-java@v4 with: distribution: "temurin" java-version: 11 @@ -78,7 +78,7 @@ jobs: with: fetch-depth: 0 # checkout tags so that dynver works properly (we need the version for MiMa) - name: Set up JDK 11 - uses: actions/setup-java@v3 + uses: actions/setup-java@v4 with: distribution: "temurin" java-version: 11 @@ -97,7 +97,7 @@ jobs: fetch-depth: 0 - uses: coursier/cache-action@v6.4 - name: Set up JDK 11 - uses: actions/setup-java@v3 + uses: actions/setup-java@v4 with: distribution: "temurin" java-version: 11 diff --git a/.github/workflows/scala-steward.yml b/.github/workflows/scala-steward.yml index 69382c80..7341f329 100644 --- a/.github/workflows/scala-steward.yml +++ b/.github/workflows/scala-steward.yml @@ -14,7 +14,7 @@ jobs: - name: Checkout uses: actions/checkout@v4 - name: Set up JDK 11 - uses: actions/setup-java@v3 + uses: actions/setup-java@v4 with: java-version: 11 - name: Cache sbt From 10f841727e4c151186d4e2fbdb45a36acb920f8c Mon Sep 17 00:00:00 2001 From: ghostbuster91 Date: Wed, 10 Apr 2024 22:11:16 +0200 Subject: [PATCH 9/9] Add note about Maintenance mode --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 910e52d1..55c47e3a 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,42 @@ [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.softwaremill.diffx/diffx-core_2.13/badge.svg)](https://search.maven.org/search?q=g:com.softwaremill.diffx) [![diffx-core Scala version support](https://index.scala-lang.org/softwaremill/diffx/diffx-core/latest-by-scala-version.svg)](https://index.scala-lang.org/softwaremill/diffx/diffx-core) - [![Gitter](https://badges.gitter.im/softwaremill/diffx.svg)](https://gitter.im/softwaremill/diffx?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-brightgreen.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org) [![Documentation Status](https://readthedocs.org/projects/diffx-scala/badge/?version=latest)](https://diffx-scala.readthedocs.io/en/latest/?badge=latest) +## Maintenance mode + +:warning: +Diffx is no longer actively developed. + +No new features will be added. + +Pull requests with bug fixes will still be merged for some time. + +New users are encouraged to try out a better alternative - [difflicious](https://github.com/jatcwang/difflicious) + +Old users should migrate to difflicious by the end of 2024. + +I am planning to archive this project by that time unless someone volunteers to take it over. + +If you spot something that is missing in difflicious that blocks your migration, please don't hesitate and open an issue there. + +If you are curious why I decided to do that here is a short summary: + +- diffx didn't have any development for quite some time. Sure some libraries are just done and there is no need for constant development. In my opinion this is not the case for diffx as + its internals should be refactored. Also there are some open bugs that should be taken care of. +- I simply don't have time and energy to maintain it anymore +- difflicious has better design so there is no point in keeping diffx around + +Thank you all for using this project. + ## Documentation diffx documentation is available at [diffx-scala.readthedocs.io](https://diffx-scala.readthedocs.io). ## Modifying documentation + The documentation is typechecked using `mdoc`. The sources for the documentation exist in `docs-sources`. Don't modify the generated documentation in `generated-docs`, as these files will get overwritten! When generating documentation, it's best to set the version to the current one, so that the generated doc files don't include modifications with the current snapshot version.