feat(diagnostic): add diagnostic.displayByVimDiagnostic

[fannheyward]

The diagnostic.displayByVimDiagnostic configuration will set diagnostics to nvim's vim.diagnostic, and prevent coc.nvim's handler to display them in virtualText/sign/floating etc.

[codecov]

Codecov Report

Attention: Patch coverage is 93.33333% with 1 line in your changes missing coverage. Please review.

Project coverage is 97.35%. Comparing base (a6e54ae) to head (2a5c5cd).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
src/diagnostic/buffer.ts	93.33%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5236      +/-   ##
==========================================
- Coverage   97.37%   97.35%   -0.02%     
==========================================
  Files         291      291              
  Lines       27027    27038      +11     
  Branches     5607     5610       +3     
==========================================
+ Hits        26317    26323       +6     
- Misses        496      498       +2     
- Partials      214      217       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[fannheyward]

@luisdavim @davidosomething I've improved this. Add diagnostic.displayByVimDiagnostic configuration, disabled by default. This configuration will set coc.nvim's diagnostics to nvim's vim.diagnostic, and prevent coc.nvim's handler like display in virtualText/floating/sign etc, please give it a try. Feedback is welcome.

[davidosomething]

can you add a user-definable function call here
i.e. diagnostics[#diagnostics + 1] = config.diagnosticFormatter({ ... })

or just on the message line
as in https://github.com/davidosomething/coc-diagnostics-shim.nvim/blob/main/lua/coc-diagnostics-shim/init.lua#L61

the use case is to apply formatting to the diagnostic message
i am currently able to do it by intercepting ale or via my diagnostic shim plugin (e.g. https://github.com/davidosomething/coc-diagnostics-shim.nvim/blob/main/lua/coc-diagnostics-shim/init.lua#L16 )

[fannheyward]

You can format the message with vim.diagnostic.config, for example:

vim.diagnostic.config({
    virtual_text = {
        format = function(diagnostic)
            return string.format('%s %s ', 'ꜰᴏʀᴍᴀᴛᴛᴇᴅ ᴡɪᴛʜ ꜰᴏʀᴍᴀᴛ-ᴛs-ᴇʀʀᴏʀs.ɴᴠɪᴍ', diagnostic.message)
        end,
    },
})