Is it possible to use suppressPackageStartupMessages on cli message?

[JBGruber]

Is there a way to write a suppressible startup message with cli? I'm writing a package for beginners of R and wanted to give some hints, but startup messages need to be suppressible to conform with CRAN guidelines. I had assumed something like this would work:

greet_startup_cli <- function() {
  cli::cli_alert_info("Hi, this is {.emph askgpt} {cli::symbol$smiley}.", class = "packageStartupMessage")
  cli::cli_li("To start error logging, run {.run [{.fun log_init}](askgpt::log_init())} now.", class = "packageStartupMessage")
  cli::cli_li("To see what you can do use {.help [{.fun ?askgpt}](askgpt::askgpt)}.", class = "packageStartupMessage")
  cli::cli_li("Or just run {.run [{.fun askgpt}](askgpt::askgpt())} with any question you want!", class = "packageStartupMessage")
}
suppressPackageStartupMessages(greet_startup_cli())
#> ℹ Hi, this is askgpt ☺.
#> • To start error logging, run `` `log_init()` `` now.
#> • To see what you can do use `?askgpt()` (`?askgpt::askgpt()`).
#> • Or just run `` `askgpt()` `` with any question you want!

^{Created on 2023-03-13 with reprex v2.0.2}

Or maybe this:

greet_startup <- function() {
  cli::cli_alert_info("Hi, this is {.emph askgpt} {cli::symbol$smiley}.")
  cli::cli_li("To start error logging, run {.run [{.fun log_init}](askgpt::log_init())} now.")
  cli::cli_li("To see what you can do use {.help [{.fun ?askgpt}](askgpt::askgpt)}.")
  cli::cli_li("Or just run {.run [{.fun askgpt}](askgpt::askgpt())} with any question you want!")
}

suppressPackageStartupMessages(withr::with_options(list(cli.message_class = "packageStartupMessage"), greet_startup()))
#> ℹ Hi, this is askgpt ☺.
#> • To start error logging, run `` `log_init()` `` now.
#> • To see what you can do use `?askgpt()` (`?askgpt::askgpt()`).
#> • Or just run `` `askgpt()` `` with any question you want!

^{Created on 2023-03-13 with reprex v2.0.2}

Am I missing something obvious?

[JBGruber]

I looked at the approach tidyverse uses and pieced something together with rlang::inform and cli::format_inline, which I'm quite happy with:

greet_startup <- function() {
  msg <- paste0(
    c(
      "Hi, this is {.emph askgpt} {cli::symbol$smiley}.",
      "{cli::symbol$bullet} To start error logging, run {.run [{.fun log_init}](askgpt::log_init())} now.",
      "{cli::symbol$bullet} To see what you can do use {.help [{.fun ?askgpt}](askgpt::askgpt)}.",
      "{cli::symbol$bullet} Or just run {.run [{.fun askgpt}](askgpt::askgpt())} with any question you want!"
    ),
    collapse = "\n"
  )
  rlang::inform(cli::format_inline(msg), class = "packageStartupMessage")
}


greet_startup()
#> Hi, this is askgpt ☺.
#> • To start error logging, run `` `log_init()` `` now.
#> • To see what you can do use `?askgpt()` (`?askgpt::askgpt()`).
#> • Or just run `` `askgpt()` `` with any question you want!
suppressPackageStartupMessages(greet_startup())

^{Created on 2023-03-14 with reprex v2.0.2}

It would be cool to get a way of doing this just in cli, but I assume you already have this in mind, so I'm closing the issue.

[gaborcsardi]

There is no good way, currently, but it is easy to add an option for this.

[dsweber2]

So... it looks like someone fixed this? At least, if you use cli_inform:

library(cli)

greet_startup_cli <- function() {
  cli_inform("Hello, world!", class = "packageStartupMessage")
}
suppressPackageStartupMessages(greet_startup_cli())

Seems to work!