MarkdownCodeWrapper

scala.build.internal.markdown.MarkdownCodeWrapper$

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

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Type members

Classlikes

case class WrappedMarkdownCode(code: String, directives: ExtractedDirectives)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def apply(subPath: SubPath, markdown: PreprocessedMarkdown): (Option[WrappedMarkdownCode], Option[WrappedMarkdownCode], Option[WrappedMarkdownCode])

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.

Attributes

markdown

preprocessed Markdown code blocks

subPath

the project os.SubPath to the Markdown file

Returns:

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

Glues raw Scala snippets into a single file.

Glues raw Scala snippets into a single file.

Attributes

snippets

a sequence of code blocks

Returns:

an option of the resulting code String

def wrapScalaCode(preprocessed: PreprocessedMarkdownCodeBlocks, wrapperName: String, pkg: Option[String]): Option[WrappedMarkdownCode]

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.

Attributes

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