Correct way to setup?

[benfrain]

I am migrating from Formatter to null-ls.

Here is my current null-ls config: (full init.lua: https://gist.github.com/benfrain/97f2b91087121b2d4ba0dcc4202d252f):

-- Setup lspconfig.
require("lspconfig").cssls.setup({
	capabilities = require("cmp_nvim_lsp").update_capabilities(vim.lsp.protocol.make_client_capabilities()),
})

require("lspconfig").tsserver.setup({
	capabilities = require("cmp_nvim_lsp").update_capabilities(vim.lsp.protocol.make_client_capabilities()),
})

-- Here is the formatting config
local null_ls = require("null-ls")
local lSsources = {
	null_ls.builtins.formatting.prettier.with({
		filetypes = {
			"javascript","typescript","css","scss","html","json","yaml","markdown","graphql","md","txt",
		},
	}),
	null_ls.builtins.formatting.stylua,
}
null_ls.setup({
	sources = lSsources,
})
vim.cmd("autocmd BufWritePost * lua vim.lsp.buf.formatting_seq_sync()")

However, while formatting is working, I a have two issues:

1. Typescript files are no longer formatting how they used to. I get spaces inside closing HTML tags in template literals e.g. </ a> (instead of </a>).
2. I get loads more (unwanted) diagnostics info – asking me about jQuery and the like!?? I have never used jQuery!

What do I need to change in my configuration?

I clearly aren't using this tool correctly. Help me Obi Wan...

[jose-elias-alvarez]

There's a few things that might be going wrong here. First, make sure you're setting up null-ls using the instructions here, which require two separate steps (null_ls.setup is deprecated). Then, you probably want to turn off tsserver formatting to avoid conflicts:

require("lspconfig").tsserver.setup({
    capabilities = require("cmp_nvim_lsp").update_capabilities(vim.lsp.protocol.make_client_capabilities()),
    on_attach = function(client)
        client.resolved_capabilities.document_formatting = false
    end,
})

I have no idea about the extra diagnostics thing, but are you sure they're coming from null-ls? Nothing in your config should affect diagnostics at all, so could you try commenting out your null-ls setup and see if the issue still pops up?

[Livingnight]

I apologize for going so far back into the past, but is "null_ls.setup({ }) actually deprecated? I see it still being used in the docs you have linked to.

[sambigelow]

@jose-elias-alvarez I see the same thing. Did this change?

[jose-elias-alvarez]

This is an old thread, please see the README for the latest setup instructions.

[benfrain]

Hi @jose-elias-alvarez – thanks for that. The only part of that set up I don't understand is what I need to do with the on_attach part here:

require("lspconfig")["null-ls"].setup({
    on_attach = my_custom_on_attach
})

Do I need the on_attach? Can I just do something like:

require("lspconfig")["null-ls"].setup({})

I apologise if this is obvious stuff, I'm very new to Lua!

BTW – I think the diagostic thing was spurious, removed all caches and reinstalled plugins and it is behaving as expected. That has also fixed the weird formatting of the tags in template literals too. No idea what was going on there.

[jose-elias-alvarez]

Nope, you don't need it, but if you're already using a callback to define things like autocommands and key bindings, you can reuse it there. Otherwise you can just pass an empty table. Glad everything is working now!

[jrafaaael]

Hello! I also have problems configuring this plugin correctly... My configuration formats when saving, but I get the following:

Error detected while processing BufWritePre Autocommands for "<buffer=1>":
Error executing vim.schedule lua callback: ...ck/packer/start/plenary.nvim/lua/plenary/async/async.lua:14: The coroutine failed with this message: ...e/pack/packer/start/null-ls.nvim/lua/null-ls/helpers.lua:164:
 command prettier is not executable (make sure it's installed and on your $PATH)
"~/code/React/heroes-app/src/components/Layout/Layout.tsx" 15L, 252C written

My config:

local servers = {'tsserver', 'html', 'cssls'}
local nvim_lsp = require('lspconfig')
-- Add additional capabilities supported by nvim-cmp
local capabilities = vim.lsp.protocol.make_client_capabilities()
capabilities = require('cmp_nvim_lsp').update_capabilities(capabilities)

-- Enable some language servers with the additional completion capabilities offered by nvim-cmp
for _, lsp in ipairs(servers) do
  nvim_lsp[lsp].setup {
    -- on_attach = my_custom_on_attach,
    capabilities = capabilities,
  }
end

require'lspconfig'.tsserver.setup{
  on_attach = function(client)
        client.resolved_capabilities.document_formatting = false
  end,
}

local null_ls = require("null-ls")

local sources = {
  null_ls.builtins.formatting.prettier,
}

null_ls.config({ sources = sources })

-- add to a specific server's on_attach,
-- or to a common on_attach callback to enable for all supported filetypes
on_attach = function(client)
    if client.resolved_capabilities.document_formatting then
        vim.cmd("autocmd BufWritePre <buffer> lua vim.lsp.buf.formatting_sync()")
    end
end

require("lspconfig")["null-ls"].setup({
    -- see the nvim-lspconfig documentation for available configuration options
    on_attach = on_attach
})

[jose-elias-alvarez]

@jrafaaael It looks like you are setting up tsserver twice. You should probably remove it from the servers list and set it up separately if you want to disable its formatting capabilities. The null-ls error is pretty clear – do you have prettier available on your $PATH?

[jrafaaael]

Thanks for your prompt response. When running the command which prettier I don't get any response. Do I have to globally install prettier (and eslint)?

[benfrain]

Yes, null-ls cannot run Prettier if it isn't installed ;)

npm i prettier -g or similar should do it. Once it is installed try running the command again and you should get something back

[gtnbssn]

Sorry i am also new and confused here. The prettier docs (at https://prettier.io/docs/en/install.html) seem to indicated prettier should be installed locally with --save-dev --save-exact, presumably so that people collaborating on a repo will all get the exact same formatting.

Should i still install prettier globally?

[benfrain]

For the sake of using it here, I would argue, yes!

[jose-elias-alvarez]

@gtnbssn Prettier will pick up on project-local config files, so you can also choose to install it globally (unless you are collaborating on projects using very old and incompatible versions of Prettier). Newer versions of null-ls will try to use locally-installed copies first if available, and you can customize the behavior further using the config options described here.

[lucasfcosta]

Is there a way for null-ls to pick up the local prettier executable? I always find myself having to npm i -g prettier.

I know it can be done, but was just wondering if someone else has done it already so that I can make my life a bit easier. Otherwise, I'll go ahead and try to do it myself, but it would be interesting to compare solutions regardless.

Thanks everyone!

[benfrain]

Hmmm. I think it does that by default. Is it not working like that for you?

[jose-elias-alvarez]

It should indeed pick it up, and if it’s not, it’s a bug. Please open an issue with steps I can follow to reproduce locally.

[koenverburg]

Hey Jose, I'm having trouble with the setup because it broke for me a couple of months ago. Reading the docs, your dotfiles and some issues. I have added the on_attach function but that doesnt do the trick.

Here is a snippet of what my setup

lsp.nullLs = function()
  local ls = require('null-ls')
  local utils = require('utils')

  ls.setup({
    debug = true,
    on_attach = utils.on_attach,
    sources = {
      ls.builtins.completion.spell,
      -- ls.builtins.formatting.stylua,

      -- ls.builtins.formatting.eslint,
      -- ls.builtins.formatting.prettier,
      -- ls.builtins.diagnostics.eslint,
    },
  })
end

And here is the error I'm getting.

[jose-elias-alvarez]

This is a separate issue - see my comment in #1156.