quarto-dev/quarto-nvim

github github
programming-languages-support
stars 242
issues 5
subscribers 7
forks 8
CREATED

2022-07-24

UPDATED

14 days ago


quarto-nvim

Quarto-nvim provides tools for working on Quarto manuscripts in Neovim. You can get started with Quarto here.

Walkthrough

The get started section also comes with a video version to walk you through. The playlist is extened as more features are added, so join us for a "Coffee with Quarto and Neovim":

https://youtu.be/3sj7clNowlA?list=PLabWm-zCaD1axcMGvf7wFxJz8FZmyHSJ7

Setup

You can install quarto-nvim from GitHub with your favourite Neovim plugin manager like lazy.nvim, packer.nvim or VimPlug.

Because Quarto provides a lot of functionality through integration with existing plugins, some of those have to be told about the existence of quarto-nvim (like e.g. registering it as a source for the autocompletion plugin nvim-cmp).

As such, we recommend you to experiment with the quarto-nvim kickstarter configuration and then pick the relevant parts from the lua/plugins/quarto.lua file to integrate it into your own existing configuration.

There is also a smaller configuration for slotting into your existing lazy.nvim (e.g. LazyVim) configuration at https://github.com/jmbuhr/lazyvim-starter-for-quarto/blob/main/lua/plugins/quarto.lua

Plugins and their configuration to look out for in either of those files are:

{
    'quarto-dev/quarto-nvim',
    'jmbuhr/otter.nvim',
    'hrsh7th/nvim-cmp',
    'neovim/nvim-lspconfig',
    'nvim-treesitter/nvim-treesitter'
}

Quarto-nvim requires Neovim >= v0.9.0 (https://github.com/neovim/neovim/releases/tag/stable). If you are unable to update Neovim, you can specify a specific version of the plugins involved instead of the latest stable version. How you do this will vary depending on your plugin manager, but you can see one example using lazy.nvim here: https://github.com/jmbuhr/quarto-nvim-kickstarter/blob/nvim-0.8.3/lua/plugins/quarto.lua

The version = ... lines to look out for are for the following plugins:

{
    'quarto-dev/quarto-nvim',
    'jmbuhr/otter.nvim',
    'nvim-treesitter/nvim-treesitter'
}

Usage

Configure

You can pass a lua table with options to the setup function as shown in quarto-nvim-kickstarter/..quarto.lua

It will be merged with the default options, which are shown below in the example. If you want to use the defaults, simply call setup without arguments or with an empty table.

require('quarto').setup{
  debug = false,
  closePreviewOnExit = true,
  lspFeatures = {
    enabled = true,
    chunks = "curly",
    languages = { "r", "python", "julia", "bash", "html" },
    diagnostics = {
      enabled = true,
      triggers = { "BufWritePost" },
    },
    completion = {
      enabled = true,
    },
  },
  codeRunner = {
    enabled = false,
    default_method = nil, -- 'molten' or 'slime'
    ft_runners = {}, -- filetype to runner, ie. `{ python = "molten" }`.
                     -- Takes precedence over `default_method`
    never_run = { "yaml" }, -- filetypes which are never sent to a code runner
  },
  keymap = {
    -- set whole section or individual keys to `false` to disable
    hover = "K",
    definition = "gd",
    type_definition = "gD",
    rename = "<leader>lR",
    format = "<leader>lf",
    references = "gr",
    document_symbols = "gS",
  }
}

Preview

Use the command

QuartoPreview

or access the function from lua, e.g. to create a keybinding:

local quarto = require('quarto')
quarto.setup()
vim.keymap.set('n', '<leader>qp', quarto.quartoPreview, { silent = true, noremap = true })

Then use the keyboard shortcut to open quarto preview for the current file or project in the active working directory in the neovim integrated terminal in a new tab.

Note: While you can use QuartoPreview without configuring the plugin via quarto.setup, other features strictly require it.

Language support

Demo

https://user-images.githubusercontent.com/17450586/209436101-4dd560f4-c876-4dbc-a0f4-b3a2cbff0748.mp4

Usage

With the language features enabled, you can open the hover documentation for R, python and julia code chunks with K (or configure a different shortcut). You can got-to-definition with gd.

Autocompletion

quarto-nvim now comes with a completion source for nvim-cmp to deliver swift autocompletion for code in quarto code chunks. With the quarto language features enabled, you can add the source in your cmp configuration:

-- ...
  sources = {
    { name = 'otter' },
  }
-- ...

R diagnostics configuration

To make diagnostics work with R you have to configure the linter a bit, since the language buffers in the background separate code with blank links, which we want to ignore. Otherwise you get a lot more diagnostics than you probably want. Add file .lintr to your home folder and fill it with:

linters: linters_with_defaults(
    trailing_blank_lines_linter = NULL,
    trailing_whitespace_linter = NULL
  )

You can now also enable other lsp features, such as the show hover function and shortcut, independent of showing diagnostics by enabling lsp features but not enabling diagnostics.

Other Edge Cases

Other languages might have similar issues (e.g. I see a lot of warnings about whitespace when activating diagnostics with lua). If you come across them and have a fix, I will be very happy about a pull request! Or, what might ultimately be the cleaner way of documenting language specific issues, an entry in the wiki.

Running Code

Quarto-nvim doesn't run code for you, instead, it will interface with existing code running plugins and tell them what to run. There are currently two such code running plugins that quarto will work with:

  1. molten-nvim - a code runner that supports the jupyter kernel, renders output below each code cell, and optionally renders images in the terminal.
  2. vim-slime - a general purpose code runner with support for sending code to integrated nvim terminals, tmux panes, and many others.

I recommend picking a code runner, setting it up based on its README, and then coming back to this point to learn how Quarto will augment that code runner.

This plugin enables easily sending code cells to your code runner. There are two different ways to do this: commands, covered below; and lua functions, covered right here. By default these functions will only run cells that are the same language as the current cell.

Quarto exposes code running functions through to runner module: require('quarto.runner'). Those functions are:

  • run_cell() - runs the current cell
  • run_above(multi_lang) - runs all the cells above the current one, and the current one, in order
  • run_below(multi_lang) - runs all the cells below the current one, and the current one, in order
  • run_all(multi_lang) - runs all the cells in the document
  • run_line(multi_lang) - runs the line of code at your cursor
  • run_range() - run code inside the visual range

Each function that takes the optional multi_lang argument will run cells of all languages when called with the value true, and will only run cells that match the language of the current cell otherwise. As a result, just calling run_all() will run all cells that match the language of the current cell.

Here are some example run mappings:

local runner = require("quarto.runner")
vim.keymap.set("n", "<localleader>rc", runner.run_cell,  { desc = "run cell", silent = true })
vim.keymap.set("n", "<localleader>ra", runner.run_above, { desc = "run cell and above", silent = true })
vim.keymap.set("n", "<localleader>rA", runner.run_all,   { desc = "run all cells", silent = true })
vim.keymap.set("n", "<localleader>rl", runner.run_line,  { desc = "run line", silent = true })
vim.keymap.set("v", "<localleader>r",  runner.run_range, { desc = "run visual range", silent = true })
vim.keymap.set("n", "<localleader>RA", function()
  runner.run_all(true)
end, { desc = "run all cells of all languages", silent = true })

Available Commands

QuartoPreview
QuartoClosePreview
QuartoHelp <..>
QuartoActivate
QuartoDiagnostics
QuartoHover
QuartoSend
QuartoSendAbove
QuartoSendBelow
QuartoSendAll
QuartoSendLine

Recommended Plugins

Quarto works great with a number of existing plugins in the neovim ecosystem. You can find semi-opinionated but still minimal configurations for nvim and tmux, for use with Quarto, R and python in these two repositories: