Skip to content

Commit bb09330

Browse files
committed
Enforce sclicheck.DocTests to include docs with compilable/failable code blocks (i.e. guides/using-directives.md)
1 parent 9d0f033 commit bb09330

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

modules/docs-tests/src/test/scala/sclicheck/DocTests.scala

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,20 @@ class DocTests extends munit.FunSuite {
1010

1111
val options: Options = Options(scalaCliCommand = Seq(TestUtil.scalaCliPath))
1212

13-
private def containsCheck(f: os.Path): Boolean =
14-
os.read.lines(f)
15-
.exists(line => line.startsWith("```md") || line.startsWith("```bash"))
13+
private def lineContainsAnyChecks(l: String): Boolean =
14+
l.startsWith("```md") || l.startsWith("```bash") ||
15+
l.startsWith("```scala compile") || l.startsWith("```scala fail") ||
16+
l.startsWith("````markdown compile") || l.startsWith("````markdown fail") ||
17+
l.startsWith("```java compile") || l.startsWith("````java fail")
18+
private def fileContainsAnyChecks(f: os.Path): Boolean =
19+
os.read.lines(f).exists(lineContainsAnyChecks)
1620

1721
for {
1822
(tpe, dir) <- dirs
1923
inputs = os.walk(dir)
2024
.filter(_.last.endsWith(".md"))
2125
.filter(os.isFile(_))
22-
.filter(containsCheck)
26+
.filter(fileContainsAnyChecks)
2327
.map(_.relativeTo(dir))
2428
.sortBy(_.toString)
2529
md <- inputs

0 commit comments

Comments
 (0)