feat: add desc option to scnvim.map, close #202

[salkin-mada]

Not sure if this would create any issues/breaking-changes in regard to the callback and flash params/args of the apply_keymap func? It seems logical to have desc as the third param. Please advice. :)

[salkin-mada]

ah yes.. would have to update the docs

[davidgranstrom]

Hi @salkin-mada, sorry about the delay. I agree it would be nice to be able to set custom descriptions to keymaps. How about making the third argument into an options table? That way we can extended it easily in the future as well.

map('editor.send_line', 'n', {
  desc = 'A custom description',
  callback = function(lines) return lines end,
  flash = true,
})

[davidgranstrom]

Btw, the docs action will fail for the moment so that can be ignored for now. You can run the lint and style checks locally using the Makefile in the root of the repository.

Edit: There seems to be an issue with the style checks on the CI, I'll have to investigate further

[davidgranstrom]

The CI workflow has been fixed by #205

[salkin-mada]

Hi @salkin-mada, sorry about the delay. I agree it would be nice to be able to set custom descriptions to keymaps. How about making the third argument into an options table? That way we can extended it easily in the future as well.

map('editor.send_line', 'n', {
  desc = 'A custom description',
  callback = function(lines) return lines end,
  flash = true,
})

Sure thing! Either my desc.value way or your options table #210 . Would just be a great detail feature to have. :)

[davidgranstrom]

Closing this PR since #210 was merged, thanks again @salkin-mada for the request!