如何在R中开发输出风格与devtools::check一致的自定义检查函数

这类devtools风格的终端输出，根本不是devtools自身代码实现的，之前追溯不到对应逻辑是正常现象——devtools的终端渲染能力全靠底层cli包支持，自身仅负责封装检查流程的调度逻辑，没有重复实现终端打印的功能。

具体实现路径 #

• 先明确devtools输出的样式本质
  你在devtools::check()、devtools::build()中看到的终端效果，是一套标准化的结构化输出规范：

  • 分块设置一级标题，用水平分割线区分不同输出区块
  • 每个检查项配标准化状态标识（成功的绿色对勾、失败的红色叉号、提示类的黄色三角）
  • 所有提示自动适配终端宽度换行，按信息层级做缩进对齐
  • 末尾设置统一的统计汇总行，同步不同状态的计数结果
    这套效果100%可以通过cli包复刻，不需要从零编写终端样式控制逻辑。

• 自定义检查函数的搭建流程

  1. 拆分原子化检查规则
     把所有对业务输出的校验需求拆成独立的判断逻辑，每个逻辑仅对应一个检查项：比如校验输出结构是否为合法列表、核心嵌套字段是否存在、量化指标是否落在合理区间、元素分布是否符合预期，每个判断单独标记结果状态（通过/失败/警告），同步维护三类结果的计数变量。
  2. 对齐devtools的输出风格
     无需手动拼接打印格式，直接调用cli包的内置样式函数即可匹配官方效果：
  • 用cli_h1()输出一级区块标题，对齐devtools的大标题视觉效果
  • 用cli_alert_success()、cli_alert_danger()、cli_alert_warning()输出单条检查提示，自动匹配状态图标、缩进、长文本自动换行
  • 用cli_rule()输出区块间的水平分割线，和devtools的分隔线视觉效果完全一致
  • 最后输出汇总统计行，复刻devtools末尾的计数汇总样式
  3. 可直接套用的基础实现框架
     下面是极简可运行的代码模板，可根据自身校验规则直接扩展：

  library(cli)
  library(glue)
  
  custom_biz_check <- function(biz_result) {
    # 启用和devtools默认一致的输出主题
    cli_theme_dark(include_marks = TRUE)
    # 初始化检查计数变量
    total <- pass <- fail <- warn <- 0
  
    cli_h1("业务输出校验结果")
  
    # 检查项1：输出结构合法性校验
    total <- total + 1
    if (is.list(biz_result)) {
      cli_alert_success("输出为合法列表结构，包含 {length(biz_result)} 个顶层元素")
      pass <- pass + 1
    } else {
      cli_alert_danger("输出类型为 {class(biz_result)}，不符合列表要求")
      fail <- fail + 1
    }
  
    # 检查项2：核心字段存在性校验
    total <- total + 1
    required_keys <- c("metric", "model", "param_config")
    missing <- setdiff(required_keys, names(biz_result))
    if (length(missing) == 0) {
      cli_alert_success("所有要求的核心字段均存在")
      pass <- pass + 1
    } else {
      cli_alert_danger("缺失核心字段：{paste(missing, collapse = ', ')}")
      fail <- fail + 1
    }
  
    # 检查项3：量化指标合理性校验
    total <- total + 1
    acc <- biz_result$metric$accuracy
    if (acc < 0.6) {
      cli_alert_warning("当前准确率为 {round(acc, 3)}，低于通用合理阈值，可调整参数优化")
      warn <- warn + 1
    } else {
      cli_alert_success("准确率为 {round(acc, 3)}，处于合理区间")
      pass <- pass + 1
    }
  
    # 分割线 + 汇总行，完全对齐devtools输出格式
    cli_rule()
    cli_text("{fail} errors ✖ | {warn} warnings ⚠ | {pass} passed ✔ | 共 {total} 项检查")
  }
  

• 源码追溯不到实现的原因
  devtools自身的代码仅承担任务调度职责：调用外部包执行检查流程、收集结构化的检查结果，所有终端渲染的样式逻辑全部下沉到底层依赖中——其中样式渲染的核心实现逻辑在cli包，检查结果的格式适配逻辑在rcmdcheck包，和devtools自身的业务代码是完全解耦的，因此仅翻阅devtools的函数定义，根本找不到对应的终端打印实现。
  后续如果需要调整输出的详细程度，还可以直接调用cli包的全局输出等级控制，调试阶段打开全量输出，日常使用仅显示警告和错误，完全和devtools的输出分级逻辑保持一致。

内容的提问来源于stack exchange，提问作者Sébastien Wouters