laika-core
API
Generated with
laika-core/laika/laika.ast/RewriteRules

RewriteRules

laika.ast.RewriteRules$
See theRewriteRules companion class
object RewriteRules

Factory methods and utilities for dealing with rewrite rules.

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

case class ChainedRewriteRules[T](rules: Seq[RewriteRule[T]]) extends T => RewriteAction[T]

Chains the specified rewrite rules so that they get applied to matching elements in the order specified in the given sequence.

Chains the specified rewrite rules so that they get applied to matching elements in the order specified in the given sequence.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait T => RewriteAction[T]
class Object
trait Matchable
class Any
Show all

Types

type RewritePhaseBuilder = PartialFunction[RewritePhase, Seq[RewriteRulesBuilder]]

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def chainFactories(rules: Seq[RewriteRulesBuilder]): RewriteRulesBuilder

Chains the specified rule factory functions into a single factory function.

Chains the specified rule factory functions into a single factory function.

Attributes

def defaultsFor(root: DocumentTreeRoot, phase: RewritePhase, slugBuilder: String => String): Seq[RewriteRulesBuilder]

The default built-in rewrite rules, dealing with section building and link resolution. These are not installed as part of any default extension bundle as they have specific ordering requirements not compatible with the standard bundle ordering in OperationConfig.

The default built-in rewrite rules, dealing with section building and link resolution. These are not installed as part of any default extension bundle as they have specific ordering requirements not compatible with the standard bundle ordering in OperationConfig.

Attributes

def empty: RewriteRules

Creates a new instance without any rules. Applying an empty instance to an AST will always return the AST unchanged.

Creates a new instance without any rules. Applying an empty instance to an AST will always return the AST unchanged.

Attributes

def forBlocks(rule: RewriteRule[Block]): RewriteRules

Creates a new instance containing only this single rule for blocks.

Creates a new instance containing only this single rule for blocks.

Attributes

def forSpans(rule: RewriteRule[Span]): RewriteRules

Creates a new instance containing only this single rule for spans.

Creates a new instance containing only this single rule for spans.

Attributes

def forTemplates(rule: RewriteRule[TemplateSpan]): RewriteRules

Creates a new instance containing only this single rule for template spans.

Creates a new instance containing only this single rule for template spans.

Attributes

Generated with