add 'full' for line_width in diagnostics options

[blue-pitaya]

Description

Added new value "full" for line_width option in builtin.diagnostics. When "full" is set there are no restrictions on diagnostics message line width and so whole message is shown.

Until this change, line_width could only be number. Maximum line width was "one width" of picker window and longer messages were cut.

This was annoying since you generally want to read whole error message.

Fixes #2020

Type of change

• New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list
relevant details about your configuration

• Verify change
• in config defaults set wrap_line = true
• open project where there is error with long message
• open diagnostics with require('telescope.builtin').diagnostics({line_width='full'})

Configuration:

• Neovim version (nvim --version): NVIM v0.8.3
• Operating system and version: Linux 6.2.6-artix1-1

Checklist:

• My code follows the style guidelines of this project (stylua)
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation (lua annotations)

[blue-pitaya]

Is this PR good to merge, or should I make some adjustments?

[jamestrew]

Hey sorry for the late response. Just a couple of suggested changes and I think we're good.

[jamestrew]

I think we should move the validation of line_width to declaration of the picker and use utils.notify instead of error.

[blue-pitaya]

Hi, thanks for checking my PR :)

I changed error to utils.notify, but left it in the same place. I couldn't find "good" place for validation in diagnostics picker, there is no direct call to line_width opt in here. Also, function 'make_entry.gen_from_diagnostics' is used specifically for diagnostics, so I guess it's not the worst place for this validation.

[jamestrew]

The problem is that unlike with error, utils.notify will let the picker continue to run and it'll eventually throw an actual error that isn't as helpful.

I think we can simplify this bit of code to

  if type(line_width) == "string" and line_width == "full" then
    line_width_opts = {}
  end

then in lua/telescope/builtin/__diagnostics.lua:124, do like

  if type(opts.line_width) == "string" and opts.line_width ~= "full" then
    utils.notify("builtin.diagnostics", {
      msg = string.format("'%s' is not a valid value for line_width", opts.line_width),
      level = "ERROR",
    })
    return
  end

[jamestrew]

Also just as a side note, noticed you're on NVIM v0.8.3 but telescope is only supporting v0.9.0+. You might want to update your neovim if you haven't already lest you might run into various issues.

[blue-pitaya]

Hi, sorry for stalling this PR so much! I applied your suggestions.

[jamestrew]

thanks!

[rlpowell]

See #2020 for example use. :)