Skip to content
This repository has been archived by the owner on Apr 6, 2018. It is now read-only.

Document a tip for improved Insert Mode mappings for ESC #946

Closed

Conversation

rdlugosz
Copy link

@rdlugosz rdlugosz commented Jan 7, 2016

As discussed at length in issue #334, mapping double characters to ESC
is a common Vim pattern (e.g, 'jj' or 'jk'). Atom supports this style of
mapping, but the editor behavior is inconsistent with Vim in that the
initial characters that partially match a mapping are not displayed on
screen. This is jarring to the user.

This PR adds documentation to the README that describes a two-step
approach to mapping ESC that removes the delay from the editor and much
more closely imitates Vim's behavior.

This issue exists today in Atom 1.3.2. A future update to Atom may
change the behavior of
KeymapManager so that
partial matches are displayed. Work in this area was most recently done in
PR #94 on atom-keymap.
It's unlikely that changing this behavior is a high priority, so I suspect this
technique will be valuable for a long time to come.

I considered adding this info to a Wiki, but since this project doesn't
currently have one I figured the README was the next-best place.
Remapping ESC is sufficiently common among Vim users that the info
should be right up front.

As discussed at length in issue atom#334, mapping double characters to ESC
is a common Vim pattern (e.g, 'jj' or 'jk'). Atom supports this style of
mapping, but the editor behavior is inconsistent with Vim in that the
initial characters that partially match a mapping are not displayed on
screen. This is jarring to the user.

This PR adds documentation to the README that describes a two-step
approach to mapping ESC that removes the delay from the editor and much
more closely imitates Vim's behavior.

This issue exists today in Atom 1.3.2. A future update to Atom may
change the behavior of
[KeymapManager](https://atom.io/docs/api/v1.3.2/KeymapManager) so that
partial matches are displayed. Work in this area was most recently done in
[PR atom#94 on atom-keymap](atom/atom-keymap#94).

I considered adding this info to the Wiki, but the project doesn't
currently have one, so I figured the README was the next-best place.
@rdlugosz rdlugosz mentioned this pull request Feb 18, 2016
@lee-dohm
Copy link
Contributor

lee-dohm commented Apr 5, 2018

As stated in the README, this package is no longer maintained and is deprecated. We recommend that people use the vim-mode-plus package instead. Because of this, we are archiving this repository and closing all issues and pull requests. Thanks very much for your support and contributions!

@lee-dohm lee-dohm closed this Apr 5, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants