tune (version 0.1.2)

message_wrap: Write a message that respects the line width

Description

Write a message that respects the line width

Usage

message_wrap(
  x,
  width = options()$width - 2,
  prefix = "",
  color_text = NULL,
  color_prefix = color_text
)

Arguments

x

A character string of the message text.

width

An integer for the width.

prefix

An optional string to go on the first line of the message.

color_text, color_prefix

A function (or NULL) that is used to color the text and/or prefix.

Value

The processed text is returned (invisibly) but a message is written.

Examples

# NOT RUN {
library(cli)
Gaiman <-
  paste(
    '"Good point." Bod was pleased with himself, and glad he had thought of',
    'asking the poet for advice. Really, he thought, if you couldn<U+2019>t trust a',
    'poet to offer sensible advice, who could you trust?',
    collapse = ""
  )
message_wrap(Gaiman)
message_wrap(Gaiman, width = 20, prefix = "-")
message_wrap(Gaiman, width = 30, prefix = "-",
             color_text = cli::col_silver)
message_wrap(Gaiman, width = 30, prefix = "-",
             color_text = cli::style_underline,
             color_prefix = cli::col_green)
# }