MarkdownCodeWrapper

A util for extraction and wrapping of code blocks in Markdown files.

class Object
trait Matchable
class Any

Value members

Concrete methods

def apply(subPath: SubPath, content: String): (Option[String], Option[String], Option[String])

Extracts scala code blocks from Markdown snippets, divides them into 3 categories and wraps when necessary.

Extracts scala code blocks from Markdown snippets, divides them into 3 categories and wraps when necessary.

Value parameters:
content

Markdown code

subPath

the project os.SubPath to the Markdown file

Returns:

a tuple of (Option(simple scala snippets code), Option(raw scala snippets code), Option(test scala snippets code))

def rawScalaCode(snippets: Seq[MarkdownCodeBlock]): Option[String]

Glues raw Scala snippets into a single file.

Glues raw Scala snippets into a single file.

Value parameters:
snippets

a sequence of code blocks

Returns:

an option of the resulting code String

def wrapScalaCode(snippets: Seq[MarkdownCodeBlock], wrapperName: String, pkg: Option[String]): Option[String]

Wraps plain scala snippets in relevant scope objects, forming a script-like wrapper.

Wraps plain scala snippets in relevant scope objects, forming a script-like wrapper.

Value parameters:
pkg

package for the wrapper object

snippets

a sequence of code blocks

wrapperName

name for the wrapper object

Returns:

an option of the wrapped code String