Visual Studio Code能否实现R Notebook实时预览功能？

前置准备 #

• R环境已安装rmarkdown包，未安装可在R终端执行install.packages("rmarkdown")完成安装
• 已完成上田祐辅R扩展的R路径基础配置
• 如需使用保存自动触发功能，提前安装VS Code扩展Run on Save

配置方案 #

方案1：自定义任务实现保存自动渲染 #

1. 打开对应R项目的工作目录，按下Ctrl+Shift+P（Mac系统为Cmd+Shift+P），输入Tasks: Configure Task，依次选择Create tasks.json file from template→Others，生成任务配置文件。
2. 将生成的tasks.json内容替换为以下代码：

{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "Render R Notebook",
            "type": "shell",
            "command": "Rscript -e \"rmarkdown::render('${file}', output_format = 'html_notebook', output_dir = dirname('${file}'))\"",
            "group": "build",
            "presentation": {
                "reveal": "silent"
            },
            "problemMatcher": []
        }
    ]
}

3. 配置保存自动触发任务：按下Ctrl+Shift+P，输入Preferences: Open Settings (JSON)，在配置文件中添加以下内容：

"files.autoSave": "afterDelay",
"files.autoSaveDelay": 1000,
"tasks.runOnSave": [
    {
        "task": "Render R Notebook",
        "filePattern": "\\.Rmd$"
    }
]

配置完成后，所有.Rmd文件在保存后都会自动执行渲染，同步更新对应.nb.html文件，效果和RStudio的R Notebook预览一致。

方案2：R包实现实时监听渲染 #

无需修改VS Code配置，直接在VS Code的R终端运行以下代码即可：

servr::httw(dir = ".", pattern = "\\.Rmd$", handler = function(files) {
  rmarkdown::render(files[1], output_format = "html_notebook")
})

运行后会自动打开浏览器预览生成的.nb.html，每次修改保存Rmd文件后，页面会自动刷新同步最新内容，无需手动操作。

补充说明 #

• 如果你使用的是普通R Markdown文件，只需要把上述配置中的output_format参数替换为对应格式（如html_document）即可适配使用。
• 若不需要开启全局自动渲染，也可以按下Ctrl+Shift+B（Mac系统为Cmd+Shift+B）手动触发构建任务完成渲染。

内容的提问来源于stack exchange，提问作者Raul Guarini Riva