A Formatter providing information that enables reporters to create more stylized output.

An example is that specification-style suites, such as FunSpec, generate output that reads more like a specification, for instance:

A Stack (when newly created)
- should be empty
- should complain when popped

This output might be generated by ScalaTest's standard out reporter. Each of these lines would be taken from the IndentedText's formattedText parameter. Were this same run to be reported in HTML or in a GUI, the output would be based on the rawText and the indentationLevel. Here's what the IndentedText values would be for each event:

• InfoProvided reported with an:

  IndentedText(
    formattedText = "A Stack (when newly created)",
    rawText = "A Stack (when newly created)",
    indentationLevel = 0
  )
  

• TestSucceeded reported with an:

  IndentedText(
    formattedText = "- should be empty",
    rawText = "should be empty",
    indentationLevel = 1
  )
  

• TestSucceeded reported with an:

  IndentedText(
    formattedText = "- should complain when popped",
    rawText = "should complain when popped",
    indentationLevel = 1
  )
  

One possible way this information could be presented in HTML, for example, is this:

A Stack (when newly created)

• should be empty
• should complain when popped