Merge pull request #3 from millerjason/cleanups

Improve opt

Author: millerjason

CHANGELOG.md

@@ -3,6 +3,7 @@
 ### 0.97
 
 * Undefine unwanted overlapping key bindings
+* Do not set Meta keys by default (improve compatibilty)
 * Update documentation
 
 ### 0.96-nvim1.0

README.md

@@ -31,19 +31,18 @@ To install the plugin with custom options (lazy example provided):
 ```lua
 {
    "millerjason/neovimacs.nvim",
-   config = function()
-        require("neovimacs").setup({
-            VM_Enabled = 1,
-            VM_StartInsert = 0,
-        })
-   end,
+   opts = {
+     VM_Enabled = true,
+     VM_StartInsert = false, -- Start in normal (not insert) mode
+   },
 }
 ```
 
 ## ✨ Options
 
-- **VM_Enabled** (default 1): enabled vimacs (if not set, no modules will be loaded)
-- **VM_StartInsert** (default 1): if set start in emacs insert mode instead of vim normal mode
+- **VM_Enabled** (default true): enabled vimacs (if not set, no modules will be loaded)
+- **VM_StartInsert** (default true): if set start in emacs insert mode instead of vim normal mode
+  **VM_UnixConsoleMetaSendsEsc** (default false): also set Meta key (required in certain terminals, requires nvim >= 0.10)
 - **TabIndentStyle**: (default "emacs"): options for "emacs", "whitespace", and "startofline" tab indent behavior
 
 ## Debugging
@@ -69,8 +68,8 @@ nvim commands to help you track down key bindings and conflicts:
 ## 🚀 Usage
 
 Many of the emacs control and meta keys (movement, kill buffers, file operations, marking) will work while
-your running viamcs in neovim.  Neovim does not allow all bindings to work in all modes, although this module
+you're running vimacs in neovim.  Neovim does not allow all bindings to work in all modes, although this module
 supports most of what is possible.
 
 Plus you still get the full power of vim moded editing as well, so vimacs can be used as a module to transition
-you from emacs to vim until you've master the vim bindings.
+you from emacs to vim until you have mastered the vim bindings.

lua/neovimacs/init.lua

@@ -2,15 +2,19 @@ local M = {}
 
 -- Default options
 M.options = {
-    -- Enable vimacs
-    VM_Enabled = 1,
+    -- Enable Vimacs
+    VM_Enabled = true,
 
     -- If set, we start in emacs edit mode
     -- (otherwise we start in vim normal mode)
-    VM_StartInsert = 1,
+    VM_StartInsert = true,
 
-    -- Tab Style: emacs, whitespace, startofline
-    TabIndentStyle = "emacs"
+    -- Should meta send escape
+    -- (required for some terminals, incompatible with others)
+    VM_UnixConsoleMetaSendsEsc = false,
+
+    -- Tab Indent Style: none, emacs, whitespace, startofline
+    TabIndentStyle = "none",
 }
 
 -- Find plugin root
@@ -23,8 +27,9 @@ M.plugin_root = find_plugin_root()
 
 -- Set vimscript globals from configuration
 function M.set_vim_globals()
-    vim.g.VM_Enabled = M.options.VM_Enabled
-    vim.g.VM_StartInsert = M.options.VM_StartInsert
+    vim.g.VM_Enabled = M.options.VM_Enabled and 1 or 0
+    vim.g.VM_StartInsert = M.options.VM_StartInsert and 1 or 0
+    vim.g.VM_UnixConsoleMetaSendsEsc = M.options.VM_UnixConsoleMetaSendsEsc and 1 or 0
     vim.g.TabIndentStyle = M.options.TabIndentStyle
 end
 
@@ -37,9 +42,9 @@ function M.setup(opts)
     vim.cmd("source " .. vimscript_path .. "vimacs.vim")
     vim.cmd("source " .. vimscript_path .. "tab-indent.vim")
     --- Undefine unwanted overlaps
-    vim.api.nvim_set_keymap('i', '<Esc>', '<Esc>', { noremap = true })
-    vim.api.nvim_set_keymap('n', '<C-a>', '<Nop>', { noremap = true })
-    vim.api.nvim_set_keymap('n', '<C-x>', '<Nop>', { noremap = true })
+    vim.api.nvim_set_keymap("i", "<Esc>", "<Esc>", { noremap = true })
+    vim.api.nvim_set_keymap("n", "<C-a>", "<Nop>", { noremap = true })
+    vim.api.nvim_set_keymap("n", "<C-x>", "<Nop>", { noremap = true })
 end
 
 return M

lua/neovimacs/vimscript/insertmode.vim

@@ -7,7 +7,9 @@ endif
 
 " insertmode equivalent (see :h insertmode) in neovim
 "
-autocmd BufWinEnter * startinsert
+if !exists("g:VM_StartInsert") || g:VM_StartInsert == 1
+  autocmd BufWinEnter * startinsert
+endif
 inoremap <Esc> <C-X><C-Z><C-]>
 inoremap <C-C> <C-X><C-Z>
 inoremap <C-L> <C-X><C-Z><C-]><Esc>

lua/neovimacs/vimscript/tab-indent.vim

@@ -18,7 +18,7 @@ if exists("loaded_TabIndent")
   finish
 endif
 
-if !exists("g:TabIndentStyle") || g:TabIndentStyle == 0
+if !exists("g:TabIndentStyle") || g:TabIndentStyle == 0 || g:TabIndentStyle == "none"
   " A user should explicitly enable tab-indent style
   finish
 endif
@@ -48,18 +48,18 @@ function! <SID>TabOrIndent()
 
     elseif g:TabIndentStyle == 2 || g:TabIndentStyle == "whitespace"
       if virtcol('.') <= indent(line('.'))
-    return indent 
+    return indent
       else
     return real_tab
       endif
 
     elseif g:TabIndentStyle == 3 || g:TabIndentStyle == "startofline"
       if virtcol('.') <= indent(line('.')) || virtcol('.') == 1
-    return indent 
+    return indent
       else
     return real_tab
       endif
-      
+
     endif
 
   else