Skip to content

TODO.md

Latest commit

 

History

History
43 lines (35 loc) · 1.96 KB

TODO.md

File metadata and controls

43 lines (35 loc) · 1.96 KB

TODO

Features

  • disable.modes option - list of vim-modes to disable screenkey in
  • group_insert - don't split keys when typing (if this is true and config.options.group_mappings is true then the insert mode mappings will be grouped and separated from 'typed' text)
  • better mapping detection system (mainly for builtin mappings)
  • hl_groups - allow user to customize the predefined highlight groups such as:
    • screenkey.hl.map - highlight group for mappings
    • screenkey.hl.key - highlight group for non-mapping keys
    • screenkey.hl.sep - highlight group for the separator
  • colorize - similar as filter but for coloring of the keys

Bugs

  • which-key duplicates keys
  • when neovim starts (and there is an error in the config), screenkey reports an error with \[...\] run :checkhealth screenkey for more details, but the default config is used when the error occurs, so the :checkhealth screenkey command does not show any errors in config
  • log text display
  • properly parse <tab>, <pageup>, <pagedown>, arrow keys, <home>, <end>, <del>, <esc>, <insert>
  • (related to the previous point) properly handle shift logic

Documentation

  • Contributing.md
  • update the README.md with the new changes
  • organize the examples in the README.md
  • create highlight section for examples in the README.md
    • add example of the window title/border coloring to the README.md
    • add example of the key coloring to the README.md
  • vim.pack example

Other

  • tests
  • more logging
  • change disable.events to be a separate option (e.g. emit_events)
  • rework logger and add option to set the log level
  • use nvim_echo to report messages (mainly in the health module)
  • remove deprecated vim.validate()
  • add examples of how to solve #59