laika.config.SyntaxHighlighting.scala Maven / Gradle / Ivy

/*
 * Copyright 2012-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package laika.config

import cats.data.NonEmptyList
import laika.api.bundle.{ BundleOrigin, ExtensionBundle, ParserBundle, SyntaxHighlighter }
import laika.parse.code.languages.*

/** Extension that registers all code syntax highlighters provided out of the box.
  *
  * The extension can be added to a transformer like any other extension:
  *
  * {{{
  * val transformer = Transformer
  *   .from(Markdown)
  *   .to(HTML)
  *   .using(GitHubFlavor)
  *   .using(SyntaxHighlighting)
  *   .build
  * }}}
  *
  * @author Jens Halm
  */
case object SyntaxHighlighting extends ExtensionBundle { self =>

  override val origin: BundleOrigin = BundleOrigin.Library

  val description: String = "Default Syntax Highlighters for Code"

  override def parsers: ParserBundle = new ParserBundle(
    syntaxHighlighters = Seq(
      ScalaSyntax,
      ScalaSyntax.Scala3,
      JavaSyntax,
      PythonSyntax,
      TypeScriptSyntax,
      TypeScriptSyntax.TSX,
      JavaScriptSyntax,
      JavaScriptSyntax.JSX,
      DartSyntax,
      AlloySyntax,
      HaskellSyntax,
      HTMLSyntax,
      CSSSyntax,
      JSONSyntax,
      HOCONSyntax,
      XMLSyntax,
      YAMLSyntax,
      ShellSyntax,
      DhallSyntax,
      SQLSyntax,
      EBNFSyntax,
      MarkdownSyntax,
      ReStructuredTextSyntax,
      LaikaExtensionSyntax.forMarkdown,
      LaikaExtensionSyntax.forRst,
      LaikaExtensionSyntax.forHTML,
      LaikaASTSyntax
    )
  )

  /** Creates a new extension bundle that contains the built-in
    * syntax highlighters as well as the specified list of custom highlighters.
    */
  def withSyntax(syntax: SyntaxHighlighter*): ExtensionBundle = new ExtensionBundle {

    override val origin: BundleOrigin = BundleOrigin.User

    val description: String = "Customized collection of Syntax Highlighters for Code"

    override def parsers: ParserBundle = new ParserBundle(
      syntaxHighlighters = self.parsers.syntaxHighlighters ++ syntax
    )

  }

  /** Creates a new extension bundle that contains the built-in
    * syntax highlighters as well as the specified highlighter, binding it to the given language string
    * instead of those declared in the instance itself.
    * Can be used to create an alias for an existing syntax, e.g. binding `dotty` to `scala` instead.
    */
  def withSyntaxBinding(binding: String, syntax: SyntaxHighlighter): ExtensionBundle = withSyntax {
    new SyntaxHighlighter {
      def language    = NonEmptyList.of(binding)
      def spanParsers = syntax.spanParsers
    }
  }

}