Add a test suite to ensure sbt does not exit eagerly

scalameta · Sep 27, 2022 · 3817567 · 3817567
1 parent cb5f5e1
commit 3817567
Show file tree

Hide file tree

Showing 7 changed files with 43 additions and 0 deletions.
diff --git a/mdoc-sbt/src/sbt-test/sbt-mdoc/extra-arguments/build.sbt b/mdoc-sbt/src/sbt-test/sbt-mdoc/extra-arguments/build.sbt
@@ -0,0 +1,3 @@
+ThisBuild / scalaVersion := "2.13.9"
+
+enablePlugins(MdocPlugin)
diff --git a/mdoc-sbt/src/sbt-test/sbt-mdoc/extra-arguments/project/build.properties b/mdoc-sbt/src/sbt-test/sbt-mdoc/extra-arguments/project/build.properties
@@ -0,0 +1 @@
+sbt.version = 1.7.1
diff --git a/mdoc-sbt/src/sbt-test/sbt-mdoc/extra-arguments/project/plugins.sbt b/mdoc-sbt/src/sbt-test/sbt-mdoc/extra-arguments/project/plugins.sbt
@@ -0,0 +1,2 @@
+addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.9.0")
+addSbtPlugin("org.scalameta" % "sbt-mdoc" % sys.props("plugin.version"))
diff --git a/mdoc-sbt/src/sbt-test/sbt-mdoc/extra-arguments/test b/mdoc-sbt/src/sbt-test/sbt-mdoc/extra-arguments/test
@@ -0,0 +1,22 @@
+# valid
+$ copy-file test-docs/valid.md docs/readme.md
+> mdoc
+
+# --check tests 
+## file has not changed to `--check` is expected to succeed
+> set mdocExtraArguments := Seq("--check")
+> mdoc
+## replace the content
+$ copy-file test-docs/valid-check.md docs/readme.md
+-> mdoc
+
+
+# --check-link-hygiene
+## file is valid so mdoc is expected to succeed
+> set mdocExtraArguments := Seq("--check-link-hygiene")
+## replace the content with a markdown with broken links
+$ copy-file test-docs/invalid.md docs/readme.md
+-> mdoc
+
+> set mdocExtraArguments := Seq.empty
+> mdoc # no error, just warnings
diff --git a/mdoc-sbt/src/sbt-test/sbt-mdoc/extra-arguments/test-docs/invalid.md b/mdoc-sbt/src/sbt-test/sbt-mdoc/extra-arguments/test-docs/invalid.md
@@ -0,0 +1,7 @@
+# Invalid
+
+This file contains an invalid link. See [Invalid](#valid).
+
+```scala mdoc
+1 + 1
+```
diff --git a/mdoc-sbt/src/sbt-test/sbt-mdoc/extra-arguments/test-docs/valid-check.md b/mdoc-sbt/src/sbt-test/sbt-mdoc/extra-arguments/test-docs/valid-check.md
@@ -0,0 +1 @@
+This file is also valid, it's used to check the `--check` flag.
diff --git a/mdoc-sbt/src/sbt-test/sbt-mdoc/extra-arguments/test-docs/valid.md b/mdoc-sbt/src/sbt-test/sbt-mdoc/extra-arguments/test-docs/valid.md
@@ -0,0 +1,7 @@
+# Valid
+
+This file is valid, with no link error. See [Valid](#valid).
+
+```scala mdoc
+1 + 1
+```
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		ThisBuild / scalaVersion := "2.13.9"

		enablePlugins(MdocPlugin)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.9.0")
		addSbtPlugin("org.scalameta" % "sbt-mdoc" % sys.props("plugin.version"))
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		This file is also valid, it's used to check the `--check` flag.