null-ls black not recognizing pyproject.toml config

[shamindras]

Thank you for creating this great package. I'm really enjoying configuring my python nvim setup with it.

I'm running into an issue with my black formatting config per here. This indeed does work in that it formats python files (on save) using the default black options. However, I want black to use my project specific options, as defined by the pyproject.toml in the root directory.

As it can be seen I've set the line formatting to be 79 characters in pyproject.toml, but black is formatting to 80 in my document. This throws an LSP warning, as per the screenshot below:

Could anyone please assist in helping configure black to use the pyproject.toml with null-ls?

[shamindras]

As an update I changed the lines:

  formatting.black,
  formatting.isort,

to the following:

  -- python
  formatting.black.with({
    condition = function(utils)
      return utils.root_has_file('pyproject.toml') -- change file extension if you use something else
    end,
  }),
  formatting.isort.with({
    condition = function(utils)
      return utils.root_has_file('pyproject.toml') -- change file extension if you use something else
    end,
  }),

however both black and isort stopped working altogether when referring to pyproject.toml in the root, which definitely exists.

Any ideas what I may be doing wrong here?

[jose-elias-alvarez]

Most likely the root is not being detected correctly, which you can verify using debug mode. If that's the case, you could try setting the cwd for the built-in using something like the code we use for isort.

[shamindras]

Thank @jose-elias-alvarez for your kind help.

So I restarted nvim in debug mode, per your suggestion. I made the change here to load black using the root_has_file(pyproject.toml) approach per above. That is, the code now has:

  -- python
  formatting.black.with({
    condition = function(utils)
      return utils.root_has_file('pyproject.toml')
    end,
    formatting.isort, -- standard formatting for isort to make debugging easier.
  }),

Then running :NullLsLog returns the following relevant output:

:NullLsLog output

[DEBUG Sat Feb  4 16:59:12 2023] ...ack/packer/start/null-ls.nvim/lua/null-ls/formatting.lua:89: received edits from generators
[TRACE Sat Feb  4 16:59:12 2023] ...ack/packer/start/null-ls.nvim/lua/null-ls/formatting.lua:90: {
  newText = "    formatting.black.with({\n      condition = function(utils)\n        return utils.root_has_file('pyproject.toml') -- change file extension if you use something else\n      end,\n  ",
  range = {
    ["end"] = {
      character = 0,
      line = 57
    },
    start = {
      character = 0,
      line = 53
    }
  },
  rangeLength = 167
}
[TRACE Sat Feb  4 16:59:12 2023] .../site/pack/packer/start/null-ls.nvim/lua/null-ls/rpc.lua:127: received LSP notification for method textDocument/didChange
[TRACE Sat Feb  4 16:59:12 2023] ...ack/packer/start/null-ls.nvim/lua/null-ls/generators.lua:21: running generators for method NULL_LS_DIAGNOSTICS
[DEBUG Sat Feb  4 16:59:12 2023] ...ack/packer/start/null-ls.nvim/lua/null-ls/generators.lua:24: no generators available
[TRACE Sat Feb  4 16:59:12 2023] .../site/pack/packer/start/null-ls.nvim/lua/null-ls/rpc.lua:127: received LSP notification for method textDocument/didSave
[TRACE Sat Feb  4 16:59:12 2023] ...ack/packer/start/null-ls.nvim/lua/null-ls/generators.lua:21: running generators for method NULL_LS_DIAGNOSTICS_ON_SAVE
[DEBUG Sat Feb  4 16:59:12 2023] ...ack/packer/start/null-ls.nvim/lua/null-ls/generators.lua:24: no generators available
[TRACE Sat Feb  4 16:59:17 2023] .../site/pack/packer/start/null-ls.nvim/lua/null-ls/rpc.lua:102: received LSP request for method shutdown
[TRACE Sat Feb  4 16:59:17 2023] .../site/pack/packer/start/null-ls.nvim/lua/null-ls/rpc.lua:127: received LSP notification for method exit
[DEBUG Sat Feb  4 16:59:18 2023] ...e/pack/packer/start/null-ls.nvim/lua/null-ls/sources.lua:48: not registering conditional source eslint_d
[DEBUG Sat Feb  4 16:59:18 2023] ...e/pack/packer/start/null-ls.nvim/lua/null-ls/sources.lua:45: registering conditional source black
[TRACE Sat Feb  4 16:59:21 2023] ...te/pack/packer/start/null-ls.nvim/lua/null-ls/client.lua:97: starting null-ls client
[TRACE Sat Feb  4 16:59:21 2023] .../site/pack/packer/start/null-ls.nvim/lua/null-ls/rpc.lua:102: received LSP request for method initialize
[TRACE Sat Feb  4 16:59:21 2023] .../site/pack/packer/start/null-ls.nvim/lua/null-ls/rpc.lua:127: received LSP notification for method initialized
[TRACE Sat Feb  4 16:59:21 2023] .../site/pack/packer/start/null-ls.nvim/lua/null-ls/rpc.lua:127: received LSP notification for method textDocument/didOpen
[TRACE Sat Feb  4 16:59:21 2023] ...ack/packer/start/null-ls.nvim/lua/null-ls/generators.lua:21: running generators for method NULL_LS_DIAGNOSTICS_ON_OPEN
[DEBUG Sat Feb  4 16:59:21 2023] ...ack/packer/start/null-ls.nvim/lua/null-ls/generators.lua:24: no generators available
[TRACE Sat Feb  4 16:59:37 2023] .../site/pack/packer/start/null-ls.nvim/lua/null-ls/rpc.lua:127: received LSP notification for method textDocument/didOpen
[TRACE Sat Feb  4 16:59:37 2023] ...ack/packer/start/null-ls.nvim/lua/null-ls/generators.lua:21: running generators for method NULL_LS_DIAGNOSTICS_ON_OPEN
[DEBUG Sat Feb  4 16:59:37 2023] ...ack/packer/start/null-ls.nvim/lua/null-ls/generators.lua:24: no generators available

It seems that there is some issue with detecting the pyproject.toml from the root directory. It definitely exists at the same level as the .git directory, which I thought root_has_file would be checking against.

Is there any way to check which directories are being checked by the has_root_file function? I suspect there may be an issue with the fact that my dotfiles for nvim are symlinked into my ~/.config/nvim directory, and null-ls may be searching for pyproject.toml in a place I'm not expecting.

...If that's the case, you could try setting the cwd for the built-in using something like the code we use for isort.

Could you please clarify the change I need to make here? Sorry, I'm relatively new to lua and nvim, so any help would be appreciated.

[jose-elias-alvarez]

It's hard to conclude anything from the log, but this line indicates that your source is getting registered:

[DEBUG Sat Feb  4 16:59:18 2023] ...e/pack/packer/start/null-ls.nvim/lua/null-ls/sources.lua:45: registering conditional source black

That means the root directory (as resolved by null-ls) does contain the file.

I'm not 100% sure I understand what the issue is here. condition is used to determine whether to register a source at all, not to actually detect the root. That logic is separate - you can either set it per built-in or globally.