API: nvim_get_mode(): return command-line type

[zeertzjq]

Feature already in Vim?

N/A (Nvim API)

Feature description

Sometimes nvim_get_mode() doesn't return enough information to indicate the current mode, especially when in command-line mode (ref vim/vim#6127, #11846), where mode returned by nvim_get_mode() sometimes doesn't start with c. A solution to this I can think of is to also return command-line type (getcmdtype()) from nvim_get_mode(). This will enable one to correctly tell whether the current mode is command-line mode from a fast API. However, introducing a new key to nvim_get_mode() will require modifying a lot of functional tests.

[zeertzjq]

Actually this can be an optional key that is present only when the current mode is command-line mode, which doesn't require modifying a lot of functional tests.

[justinmk]

Related: #18194

Actually this can be an optional key that is present only when the current mode is command-line mode, which doesn't require modifying a lot of functional tests.

The interface is most important. Modifying tests is a one-time cost. The interface is forever.