move GitHubFlavor to Markdown companion

typelevel · Sep 15, 2023 · dd90bc5 · dd90bc5
1 parent f692a95
commit dd90bc5
Show file tree

Hide file tree

Showing 28 changed files with 114 additions and 159 deletions.
diff --git a/core/shared/src/main/scala/laika/format/Markdown.scala b/core/shared/src/main/scala/laika/format/Markdown.scala
@@ -16,10 +16,17 @@
 
 package laika.format
 
-import laika.api.bundle.{ BlockParserBuilder, ExtensionBundle, SpanParserBuilder }
+import laika.api.bundle.{
+  BlockParserBuilder,
+  BundleOrigin,
+  ExtensionBundle,
+  ParserBundle,
+  SpanParserBuilder
+}
 import laika.api.format.MarkupFormat
 import laika.ast.Block
 import laika.markdown.bundle.VerbatimHTML
+import laika.markdown.github.*
 import laika.markdown.{ BlockParsers, InlineParsers, ListParsers }
 import laika.parse.Parser
 import laika.parse.text.{ CharGroup, TextParsers }
@@ -170,6 +177,48 @@ case object Markdown extends MarkupFormat {
 
   val extensions: Seq[ExtensionBundle] = Seq(VerbatimHTML)
 
+  /** Extension bundle that enables GitHub-Flavored Markdown on top of standard Markdown.
+    *
+    * The extension can be added to a transformer like any other extension:
+    *
+    * {{{
+    *   val transformer = Transformer
+    *     .from(Markdown)
+    *     .to(HTML)
+    *     .using(GitHubFlavor)
+    *     .build
+    * }}}
+    *
+    * These are the parsers this extension adds to standard Markdown:
+    *
+    * - strikethrough
+    * - auto-links (urls and email addresses)
+    * - fenced code blocks
+    * - tables
+    *
+    * @author Jens Halm
+    */
+  object GitHubFlavor extends ExtensionBundle {
+
+    val description: String = "Github-flavored Markdown"
+
+    override val origin: BundleOrigin = BundleOrigin.Parser
+
+    override def parsers: ParserBundle = new ParserBundle(
+      blockParsers = Seq(
+        Tables.parser
+      ) ++ FencedCodeBlocks.parsers,
+      spanParsers = Seq(
+        Strikethrough.parser,
+        AutoLinks.parsers.www,
+        AutoLinks.parsers.http,
+        AutoLinks.parsers.email
+      )
+    )
+
+    override def forStrictMode: Option[ExtensionBundle] = None
+  }
+
   override def createBlockListParser(parser: Parser[Block]): Parser[Seq[Block]] =
     super.createBlockListParser(BlockParsers.insignificantSpaces ~> parser)
 

diff --git a/core/shared/src/main/scala/laika/markdown/github/AutoLinks.scala b/core/shared/src/main/scala/laika/markdown/github/AutoLinks.scala
@@ -29,7 +29,7 @@ import laika.parse.uri.AutoLinkParsers
   *
   * @author Jens Halm
   */
-private[github] object AutoLinks {
+private[laika] object AutoLinks {
 
   private val startChars = NonEmptySet.of('*', '_', '~', '(', ' ', '\n')
   private val endChars   = NonEmptySet.of('*', '_', '~', ')', '?', '!', '.', ',', ':', ' ', '\n')

diff --git a/core/shared/src/main/scala/laika/markdown/github/FencedCodeBlocks.scala b/core/shared/src/main/scala/laika/markdown/github/FencedCodeBlocks.scala
@@ -29,7 +29,7 @@ import laika.parse.{ BlockSource, Failure, Parser, Success }
   *
   * @author Jens Halm
   */
-private[github] object FencedCodeBlocks {
+private[laika] object FencedCodeBlocks {
 
   private def reverse(offset: Int, p: => Parser[String]): Parser[String] = Parser { in =>
     p.parse(in.reverse.consume(offset)) match {

diff --git a/core/shared/src/main/scala/laika/markdown/github/GitHubFlavor.scala b/core/shared/src/main/scala/laika/markdown/github/GitHubFlavor.scala
diff --git a/core/shared/src/main/scala/laika/markdown/github/Strikethrough.scala b/core/shared/src/main/scala/laika/markdown/github/Strikethrough.scala
@@ -26,7 +26,7 @@ import laika.markdown.InlineParsers.enclosedByDoubleChar
   *
   * @author Jens Halm
   */
-private[github] object Strikethrough {
+private[laika] object Strikethrough {
 
   val parser: SpanParserBuilder = SpanParserBuilder.recursive { implicit recParsers =>
     enclosedByDoubleChar('~').map { Deleted(_) }

diff --git a/core/shared/src/main/scala/laika/markdown/github/Tables.scala b/core/shared/src/main/scala/laika/markdown/github/Tables.scala
@@ -30,7 +30,7 @@ import laika.parse.implicits._
   *
   * @author Jens Halm
   */
-private[github] object Tables {
+private[laika] object Tables {
 
   val parser: BlockParserBuilder = BlockParserBuilder.withSpans { spanParsers =>
     def cell(textParser: Parser[LineSource], cellType: CellType): Parser[Cell] =

diff --git a/core/shared/src/test/scala/laika/config/OperationConfigSpec.scala b/core/shared/src/test/scala/laika/config/OperationConfigSpec.scala
@@ -27,7 +27,7 @@ import laika.bundle.BundleProvider
 import MarkupFormat.MarkupParsers
 import laika.api.bundle.{ BlockParserBuilder, BundleOrigin, ExtensionBundle, SpanParserBuilder }
 import laika.markdown.bundle.VerbatimHTML
-import laika.markdown.github.GitHubFlavor
+import laika.format.Markdown.GitHubFlavor
 import munit.FunSuite
 
 /** @author Jens Halm

diff --git a/core/shared/src/test/scala/laika/markdown/GitHubFlavorSpec.scala b/core/shared/src/test/scala/laika/markdown/GitHubFlavorSpec.scala
@@ -17,10 +17,9 @@
 package laika.markdown
 
 import laika.api.builder.OperationConfig
-import laika.ast._
+import laika.ast.*
 import laika.ast.sample.ParagraphCompanionShortcuts
 import laika.format.Markdown
-import laika.markdown.github.GitHubFlavor
 import laika.parse.Parser
 import laika.parse.markup.RootParser
 import munit.FunSuite
@@ -30,7 +29,7 @@ class GitHubFlavorSpec extends FunSuite with ParagraphCompanionShortcuts {
   val rootParser = new RootParser(
     Markdown,
     new OperationConfig(Markdown.extensions)
-      .withBundles(Seq(GitHubFlavor)).markupExtensions
+      .withBundles(Seq(Markdown.GitHubFlavor)).markupExtensions
   )
 
   val defaultParser: Parser[RootElement] = rootParser.rootElement

diff --git a/core/shared/src/test/scala/laika/parse/PositionTrackingSpec.scala b/core/shared/src/test/scala/laika/parse/PositionTrackingSpec.scala
@@ -19,14 +19,13 @@ package laika.parse
 import laika.api.MarkupParser
 import laika.api.errors.ParserError
 import laika.format.Markdown
-import laika.markdown.github.GitHubFlavor
 import munit.FunSuite
 
 /** @author Jens Halm
   */
 class PositionTrackingSpec extends FunSuite {
 
-  private val parser = MarkupParser.of(Markdown).using(GitHubFlavor).build
+  private val parser = MarkupParser.of(Markdown).using(Markdown.GitHubFlavor).build
 
   def parseAndExtractMessage(input: String): String = parser.parse(input) match {
     case Left(ParserError(message)) => message

diff --git a/core/shared/src/test/scala/laika/parse/code/languages/LanguageSpec.scala b/core/shared/src/test/scala/laika/parse/code/languages/LanguageSpec.scala
@@ -21,7 +21,6 @@ import laika.api.errors.ParserError
 import laika.ast.*
 import laika.config.{ LaikaKeys, SyntaxHighlighting }
 import laika.format.Markdown
-import laika.markdown.github.GitHubFlavor
 import laika.parse.code.CodeCategory
 import laika.parse.code.CodeCategory.*
 import munit.FunSuite
@@ -32,7 +31,7 @@ class LanguageSpec extends FunSuite {
 
   private val parser = MarkupParser
     .of(Markdown)
-    .using(GitHubFlavor, SyntaxHighlighting)
+    .using(Markdown.GitHubFlavor, SyntaxHighlighting)
     .withConfigValue(LaikaKeys.firstHeaderAsTitle, true)
     .build
 

diff --git a/docs/src/02-running-laika/01-sbt-plugin.md b/docs/src/02-running-laika/01-sbt-plugin.md
@@ -285,10 +285,10 @@ Register implementations of the `ExtensionBundle` API, either provided by the li
 Example:
 
 ```scala mdoc:compile-only
-import laika.markdown.github.GitHubFlavor
+import laika.format.Markdown
 import laika.config.SyntaxHighlighting
 
-laikaExtensions := Seq(GitHubFlavor, SyntaxHighlighting)
+laikaExtensions := Seq(Markdown.GitHubFlavor, SyntaxHighlighting)
 ``` 
 
 - [Overriding Renderers]: adjust the rendered output for specific AST node types.

diff --git a/docs/src/02-running-laika/02-library-api.md b/docs/src/02-running-laika/02-library-api.md
@@ -128,12 +128,10 @@ The instances are immutable and thread-safe.
 Example for creating a transformer for Markdown, including the GitHub-Flavor extensions:
 
 ```scala mdoc:silent
-import laika.markdown.github.GitHubFlavor
-
 val transformer = Transformer
   .from(Markdown)
   .to(HTML)
-  .using(GitHubFlavor)
+  .using(Markdown.GitHubFlavor)
   .build
 ```
 
@@ -194,13 +192,12 @@ from cats.IO for initialization:
 ```scala mdoc
 import cats.effect.{ Async, Resource }
 import laika.io.api.TreeTransformer
-import laika.markdown.github.GitHubFlavor
 
 def createTransformer[F[_]: Async]: Resource[F, TreeTransformer[F]] =
   Transformer
     .from(Markdown)
     .to(HTML)
-    .using(GitHubFlavor)
+    .using(Markdown.GitHubFlavor)
     .parallel[F]
     .build
 ``` 
@@ -338,7 +335,7 @@ as well as copying static files over to the target directory.
 val transformerIO = Transformer
   .from(Markdown)
   .to(HTML)
-  .using(GitHubFlavor)
+  .using(Markdown.GitHubFlavor)
   .parallel[IO]
   .build
 ```
@@ -366,7 +363,7 @@ merging all content from the input directories into a single, linearized e-book:
 val epubTransformer = Transformer
   .from(Markdown)
   .to(EPUB)
-  .using(GitHubFlavor)
+  .using(Markdown.GitHubFlavor)
   .parallel[IO]
   .build
 
@@ -511,7 +508,7 @@ First we set up a parser and its configuration.
 We create a parallel parser that is capable of reading from a directory:
 
 ```scala mdoc:silent
-val parserBuilder = MarkupParser.of(Markdown).using(GitHubFlavor)
+val parserBuilder = MarkupParser.of(Markdown).using(Markdown.GitHubFlavor)
 
 val parser = parserBuilder.parallel[IO].build
 
@@ -628,7 +625,7 @@ val theme = Helium.defaults
 val heliumTransformer = Transformer
   .from(Markdown)
   .to(HTML)
-  .using(GitHubFlavor)
+  .using(Markdown.GitHubFlavor)
   .parallel[IO]
   .withTheme(theme)
   .build
@@ -697,7 +694,7 @@ import laika.preview.ServerBuilder
 
 val parser = MarkupParser
   .of(Markdown)
-  .using(GitHubFlavor)
+  .using(Markdown.GitHubFlavor)
   .parallel[IO]
   .build
 

diff --git a/docs/src/02-running-laika/03-configuration.md b/docs/src/02-running-laika/03-configuration.md
@@ -108,12 +108,11 @@ laikaConfig := LaikaConfig.defaults.strict
 ```scala mdoc:compile-only
 import laika.api._
 import laika.format._
-import laika.markdown.github.GitHubFlavor
 
 val transformer = Transformer
   .from(Markdown)
   .to(HTML)
-  .using(GitHubFlavor)
+  .using(Markdown.GitHubFlavor)
   .strict
   .build
 ```
@@ -151,12 +150,11 @@ laikaConfig := LaikaConfig.defaults.withRawContent
 ```scala mdoc:compile-only
 import laika.api._
 import laika.format._
-import laika.markdown.github.GitHubFlavor
 
 val transformer = Transformer
   .from(Markdown)
   .to(HTML)
-  .using(GitHubFlavor)
+  .using(Markdown.GitHubFlavor)
   .withRawContent
   .build
 ```
@@ -254,12 +252,11 @@ laikaConfig := LaikaConfig.defaults
 import laika.api._
 import laika.format._
 import laika.ast.MessageFilter
-import laika.markdown.github.GitHubFlavor
 
 val transformer = Transformer
   .from(Markdown)
   .to(HTML)
-  .using(GitHubFlavor)
+  .using(Markdown.GitHubFlavor)
   .failOnMessages(MessageFilter.None)
   .renderMessages(MessageFilter.Error)
   .build
@@ -347,12 +344,11 @@ laikaConfig := LaikaConfig.defaults
 ```scala mdoc:compile-only
 import laika.api._
 import laika.format._
-import laika.markdown.github.GitHubFlavor
 
 val transformer = Transformer
   .from(Markdown)
   .to(HTML)
-  .using(GitHubFlavor)
+  .using(Markdown.GitHubFlavor)
   .withConfigValue("version.latest", "2.4.6")
   .withConfigValue("license", "Apache 2.0")
   .build

diff --git a/docs/src/03-preparing-content/01-directory-structure.md b/docs/src/03-preparing-content/01-directory-structure.md
@@ -69,12 +69,11 @@ laikaConfig := LaikaConfig.defaults
 import laika.config.LaikaKeys
 import laika.api._
 import laika.format._
-import laika.markdown.github.GitHubFlavor
 
 val transformer = Transformer
   .from(Markdown)
   .to(HTML)
-  .using(GitHubFlavor)
+  .using(Markdown.GitHubFlavor)
   .withConfigValue(LaikaKeys.titleDocuments.inputName, "title")
   .withConfigValue(LaikaKeys.titleDocuments.outputName, "title")
   .build