docs(neovim): add configuration guide for Neovim as LSP client #270

PMassicotte · 2025-02-27T16:03:47Z

Introduce a new documentation file for configuring Neovim as a Language Server Protocol (LSP) client using nvim-lspconfig and conform.nvim. This guide provides step-by-step instructions for setting up Air as an LSP client and enabling automatic formatting on save. Update the main editors documentation to include a link to the new Neovim guide, expanding the list of supported editors.

PMassicotte · 2025-02-27T16:05:00Z

Did that rapidly, please let me know if I missed something. This configuration has worked fine for me for the past few days.

Introduce a new documentation file for configuring Neovim as a Language Server Protocol (LSP) client using nvim-lspconfig and conform.nvim. This guide provides step-by-step instructions for setting up Air as an LSP client and enabling automatic formatting on save. Update the main editors documentation to include a link to the new Neovim guide, expanding the list of supported editors.

m-muecke · 2025-02-27T17:45:45Z

Did that rapidly, please let me know if I missed something. This configuration has worked fine for me for the past few days.

Nice! Since air is already merged in nvim-lspconfig one doesn't have to create a custom setup and the following is sufficient:

require("lspconfig").air.setup({})

and maybe adding a guide on using air and other language servers such as r-language-server to disable the formatting.

PMassicotte · 2025-02-27T17:55:09Z

Nice! The config for using nvim-lspconfig is missing and a guide for disabling the formatting compatibility of r-language-server when both are in use. Hence, the setup for lspconfig is just the following:
require("lspconfig").air.setup({})

Thank you for your inputs 👍

Do you mean to add this after the require("lspconfig.configs").air block?

require("lspconfig").air.setup({})

PMassicotte · 2025-02-27T17:55:59Z

Let me try just calling setup.

PMassicotte · 2025-02-27T17:57:58Z

You

Nice! Since air is already merged in nvim-lspconfig one doesn't have to create a custom setup and the following is sufficient:
require("lspconfig").air.setup({})

You are absolutely right. I will modify accordingly.

…ult setup method

TymekDev

Thanks for putting this together! I have added some comments with my feedback.

docs/editor-neovim.qmd

TymekDev · 2025-02-27T21:19:03Z

docs/editor-neovim.qmd

+To enable automatic formatting on save, add the following to your `nvim/after/plugin/lsp.lua` (or other appropriate location):
+
+```lua
+vim.api.nvim_create_autocmd("BufWritePre", {


Do you think it makes sense to provide this autocmd? I'd expect everyone to already have something like this in their config.

However, for the completeness (e.g. for Neovim newcomers) it might make sense to keep it.

Worth to consider: using ftplugin.

Putting the below command in either ftplugin/r.lua or after/ftplugin/r.lua would have a roughly the same effect. I supposed it's a style preference of using pattern vs. filetypes.

vim.api.nvim_create_autocmd("BufWritePre", { buffer = 0, callback = function() vim.lsp.buf.format() end, })

Worth to consider: using ftplugin.

Putting the below command in either ftplugin/r.lua or after/ftplugin/r.lua would have a roughly the same effect. I supposed it's a style preference of using pattern vs. filetypes.

vim.api.nvim_create_autocmd("BufWritePre", { buffer = 0, callback = function() vim.lsp.buf.format() end, })

I think you are right, either are fine. Maybe we can propose both solution/approach. Using the filter might be better for those that also have rlanguageserver to be specific on which one to use?

When responding to another comment, I just realized that on_attach seems to make the all-in-one setup() call:

require("lspconfig").air.setup({ on_attach = function(_, bufnr) vim.api.nvim_create_autocmd("BufWritePre", { buffer = bufnr, callback = function() vim.lsp.buf.format() end, }) end, })

I will use your solution, it makes sens and likely easier to configure for neovim newcomer. Thank you.

docs/editor-neovim.qmd

TymekDev · 2025-02-27T21:28:57Z

docs/editor-neovim.qmd

+return {
+    "stevearc/conform.nvim",
+    enabled = true,
+    config = function()
+        local conform = require("conform")
+
+        conform.setup({
+            notify_on_error = true,
+            format_on_save = {
+                lsp_fallback = true,
+            },
+            formatters_by_ft = {
+                r = { "air" },
+            },
+        })
+    end,
+}


That's a lazy.nvim-specific setup. I'd suggest using a generic setup (example below) and point to conform's README for a way to install the plugin.

require("conform").setup({ formatters_by_ft = { r = { "air" }, }, })

What about filetypes for R markdown and Quatro?

Currently not supported.

#265

TymekDev · 2025-02-27T21:31:02Z

docs/editor-neovim.qmd

+
+## conform.nvim configuration
+
+Air can be configured as a formatter plugin via [conform.nvim](https://github.com/stevearc/conform.nvim). This allows you to format R code with Air inside code chunks in Quarto and RMarkdown documents. It can be configured by adding the following to your `nvim/lua/plugins/conform.lua`:


Suggested change

Air can be configured as a formatter plugin via [conform.nvim](https://github.com/stevearc/conform.nvim). This allows you to format R code with Air inside code chunks in Quarto and RMarkdown documents. It can be configured by adding the following to your `nvim/lua/plugins/conform.lua`:

Air can be used as a formatter via [conform.nvim](https://github.com/stevearc/conform.nvim). This allows using Air to format R code inside code chunks in Quarto and RMarkdown documents. It can be configured by adding the following to your configuration:

This allows you to format R code with Air inside code chunks in Quarto and RMarkdown documents.

Is this an out-of-the-box functionality or does one need to configure tree-sitter injections? 👀

I think it is out of the box, my conform config is pretty simple.

@TymekDev and @PMassicotte can you please double check that Air works in various Quarto and RMarkdown documents? I have my doubts because I went looking in conform and could not find any specific Quarto support for LSP/formatting passthrough.

If it does seem to be working, I'd love to know what I missed so I can study how it works on the conform side

@TymekDev and @PMassicotte can you please double check that Air works in various Quarto and RMarkdown documents? I have my doubts because I went looking in conform and could not find any specific Quarto support for LSP/formatting passthrough.

If it does seem to be working, I'd love to know what I missed so I can study how it works on the conform side

@DavisVaughan conform.nvim supports injected language formatting this is probably what's meant here, see the following: https://github.com/stevearc/conform.nvim/blob/master/doc/advanced_topics.md#injected-language-formatting-code-blocks. I can confirm that it works with Rmarkdown and Quarto files, I'm guessing since Rmarkdown and Quarto inherit from markdown treesitter it works "out of the box".

Co-authored-by: Tymoteusz Makowski <[email protected]>

Tx! Co-authored-by: Tymoteusz Makowski <[email protected]>

…add link to documentation for further guidance

docs/editor-neovim.qmd

Co-authored-by: Lionel Henry <[email protected]>

…n save and disable conflicting formatter

PMassicotte · 2025-02-28T12:37:23Z

I think I have managed to include everyone's comment. Thank you very much.

docs/editor-neovim.qmd

lionel- · 2025-02-28T15:52:25Z

One question, is it possible to use Air as a language server in general and still configure conform to use it for Quarto documents at the same time?

lionel- · 2025-02-28T16:01:50Z

I think this bit from their README indicates that both can be used simultaneously:

Fixes bad-behaving LSP formatters - Some LSP servers are lazy and simply replace the entire buffer, leading to the problems mentioned above. Conform hooks into the LSP handler and turns these responses into proper piecewise changes.

PMassicotte · 2025-02-28T17:00:51Z

One question, is it possible to use Air as a language server in general and still configure conform to use it for Quarto documents at the same time?

Yes, it can be used for both, R files with the lsp-config and quarto/rmd when adding the conform configuration.

DavisVaughan · 2025-03-03T21:47:39Z

docs/editor-neovim.qmd

+require("lspconfig").air.setup({
+    on_attach = function(_, bufnr)
+        vim.api.nvim_create_autocmd("BufWritePre", {
+            buffer = bufnr,
+            callback = function()
+                vim.lsp.buf.format()
+            end,
+        })
+    end,
+})


Can someone help me understand why the on_attach is required?

I'm comparing to ruff, for example:
https://docs.astral.sh/ruff/editors/setup/#neovim

That does not have this on_attach hook to enable the BufWritePre pre-write hook. I would have thought that just setting up Air as an LSP would have activated something like this on its own.

Is Ruff's documentation missing something? Is this BufWritePre overkill? Or am I missing something else?

(I'll take over doc changes from here on, so please just leave a comment rather than pushing)

Technically, it's not reuiqred. However, without it formatting will work only on demand (by manually running vim.lsp.buf.format()). Adding this particular on_attach effectively enables formatting on save.

Ok so IIUC its like editor.formatOnSave in VS Code. Without that, you can invoke Format Document to tell the LSP to format your document, but with that setting set to true it will do so automatically on every save.

I guess in ruff they just didn't think to say that part.

But makes sense to me thanks!

DavisVaughan · 2025-03-03T22:17:51Z

Thanks @PMassicotte, @TymekDev, and @m-muecke!

PMassicotte · 2025-03-03T22:18:15Z

Thanks @PMassicotte, @TymekDev, and @m-muecke!

Thank you everyone!

PMassicotte force-pushed the main branch from 722114b to 411c58f Compare February 27, 2025 17:04

PMassicotte mentioned this pull request Feb 27, 2025

neovim integration #226

Closed

docs(neovim): simplify LSP client configuration for Air by using defa…

009df8d

…ult setup method

TymekDev suggested changes Feb 27, 2025

View reviewed changes

PMassicotte and others added 4 commits February 27, 2025 16:40

Update docs/editor-neovim.qmd

a13afaf

Co-authored-by: Tymoteusz Makowski <[email protected]>

Update docs/editor-neovim.qmd

6ae2a0b

Co-authored-by: Tymoteusz Makowski <[email protected]>

Update docs/editor-neovim.qmd

bb94158

Tx! Co-authored-by: Tymoteusz Makowski <[email protected]>

docs(editor-neovim): simplify conform.nvim configuration example and …

e06f586

…add link to documentation for further guidance

lionel- reviewed Feb 28, 2025

View reviewed changes

docs/editor-neovim.qmd Outdated Show resolved Hide resolved

docs/editor-neovim.qmd Outdated Show resolved Hide resolved

docs/editor-neovim.qmd Outdated Show resolved Hide resolved

docs/editor-neovim.qmd Outdated Show resolved Hide resolved

docs/editor-neovim.qmd Show resolved Hide resolved

PMassicotte and others added 5 commits February 28, 2025 06:45

Update docs/editor-neovim.qmd

001b82d

Co-authored-by: Lionel Henry <[email protected]>

Update docs/editor-neovim.qmd

088da04

Co-authored-by: Lionel Henry <[email protected]>

Update docs/editor-neovim.qmd

68bf19a

Co-authored-by: Lionel Henry <[email protected]>

Update docs/editor-neovim.qmd

19bb536

Co-authored-by: Lionel Henry <[email protected]>

Update docs/editor-neovim.qmd

4705d77

Co-authored-by: Lionel Henry <[email protected]>

PMassicotte mentioned this pull request Feb 28, 2025

RBuildTags gives message: 'file "etags" exists ...' but it doesn't. R-nvim/R.nvim#349

Closed

docs(editor-neovim): update LSP configuration to auto-format R code o…

810dfe0

…n save and disable conflicting formatter

lionel- approved these changes Feb 28, 2025

View reviewed changes

docs/editor-neovim.qmd Outdated Show resolved Hide resolved

Let Visual Editor do its thing

2c167cf

DavisVaughan reviewed Mar 3, 2025

View reviewed changes

Add to sidebar

9a341b4

DavisVaughan added 3 commits March 3, 2025 17:10

Capitalization

c204d72

Align with format of other editor- guides

cd1e96f

Tweak

3e05ef2

DavisVaughan merged commit cc7f6bc into posit-dev:main Mar 3, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(neovim): add configuration guide for Neovim as LSP client #270

docs(neovim): add configuration guide for Neovim as LSP client #270

PMassicotte commented Feb 27, 2025

PMassicotte commented Feb 27, 2025

m-muecke commented Feb 27, 2025 •

edited

Loading

PMassicotte commented Feb 27, 2025

PMassicotte commented Feb 27, 2025

PMassicotte commented Feb 27, 2025

TymekDev left a comment

TymekDev Feb 27, 2025

TymekDev Feb 27, 2025

PMassicotte Feb 27, 2025 •

edited

Loading

TymekDev Feb 28, 2025

PMassicotte Feb 28, 2025

TymekDev Feb 27, 2025

PMassicotte Feb 27, 2025 •

edited

Loading

TymekDev Feb 27, 2025

PMassicotte Feb 27, 2025

DavisVaughan Feb 27, 2025

m-muecke Feb 27, 2025 •

edited

Loading

PMassicotte commented Feb 28, 2025

lionel- commented Feb 28, 2025

lionel- commented Feb 28, 2025

PMassicotte commented Feb 28, 2025

DavisVaughan Mar 3, 2025 •

edited

Loading

TymekDev Mar 3, 2025

DavisVaughan Mar 3, 2025

DavisVaughan commented Mar 3, 2025

PMassicotte commented Mar 3, 2025


		## conform.nvim configuration

		Air can be configured as a formatter plugin via [conform.nvim](https://github.com/stevearc/conform.nvim). This allows you to format R code with Air inside code chunks in Quarto and RMarkdown documents. It can be configured by adding the following to your `nvim/lua/plugins/conform.lua`:

	Air can be configured as a formatter plugin via [conform.nvim](https://github.com/stevearc/conform.nvim). This allows you to format R code with Air inside code chunks in Quarto and RMarkdown documents. It can be configured by adding the following to your `nvim/lua/plugins/conform.lua`:
	Air can be used as a formatter via [conform.nvim](https://github.com/stevearc/conform.nvim). This allows using Air to format R code inside code chunks in Quarto and RMarkdown documents. It can be configured by adding the following to your configuration:

docs(neovim): add configuration guide for Neovim as LSP client #270

docs(neovim): add configuration guide for Neovim as LSP client #270

Conversation

PMassicotte commented Feb 27, 2025

PMassicotte commented Feb 27, 2025

m-muecke commented Feb 27, 2025 • edited Loading

PMassicotte commented Feb 27, 2025

PMassicotte commented Feb 27, 2025

PMassicotte commented Feb 27, 2025

TymekDev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PMassicotte Feb 27, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PMassicotte Feb 27, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

m-muecke Feb 27, 2025 • edited Loading

Choose a reason for hiding this comment

PMassicotte commented Feb 28, 2025

lionel- commented Feb 28, 2025

lionel- commented Feb 28, 2025

PMassicotte commented Feb 28, 2025

DavisVaughan Mar 3, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DavisVaughan commented Mar 3, 2025

PMassicotte commented Mar 3, 2025

m-muecke commented Feb 27, 2025 •

edited

Loading

PMassicotte Feb 27, 2025 •

edited

Loading

PMassicotte Feb 27, 2025 •

edited

Loading

m-muecke Feb 27, 2025 •

edited

Loading

DavisVaughan Mar 3, 2025 •

edited

Loading