Merge pull request #139 from aileot/feat-keymap-remap_option

feat(keymap): detect `remap` option in `extra-opts`

Author: aileot

doc/MACROS.md

@@ -55,7 +55,7 @@ For example,
 
 ### api-opts
 
-It is kv-table `{}` option for the api functions, `vim.api.nvim_foo`. Unless
+It is kv-table `{}` option for the api functions, `vim.api.nvim_foo()`. Unless
 otherwise noted, this option has the following features:
 
 - It only accepts the same key/value described in `api.txt`.
@@ -128,9 +128,9 @@ Create or get an augroup, or override an existing augroup.
 
   Note: Set `vim.fn.foobar`, or set `:foobar` to `callback` with `<command>` key
   in `extra-opts`, to call Vim script function `foobar` without table arg from
-  `nvim_create_autocmd`; instead, set `#(vim.fn.foobar $)` to call `foobar` with
-  the table arg.
-- [`?api-opts`](#api-opts): (kv-table) `:h nvim_create_autocmd`.
+  `nvim_create_autocmd()`; instead, set `#(vim.fn.foobar $)` to call `foobar`
+  with the table arg.
+- [`?api-opts`](#api-opts): (kv-table) `:h nvim_create_autocmd()`.
 
 ```fennel
 (augroup! :sample-augroup
@@ -215,14 +215,14 @@ c.f. [`augroup!`](#augroup), [`autocmd!`](#autocmd)
 Create an autocmd.
 
 ```fennel
-(autocmd! events api-opts) ; Just as an alias of `nvim_create_autocmd`.
+(autocmd! events api-opts) ; Just as an alias of `nvim_create_autocmd()`.
 (autocmd! name-or-id events ?pattern ?extra-opts callback ?api-opts)
 ```
 
 - `name-or-id`: (string|integer|nil) The autocmd group name or id to match
-  against. It is necessary unlike `vim.api.nvim_create_autocmd` unless this
-  `autocmd!` macro is within either `augroup!` or `augroup+`. Set it to `nil` to
-  define `autocmd`s affiliated with no augroup.
+  against. It is necessary unlike `nvim_create_autocmd()` unless this `autocmd!`
+  macro is within either `augroup!` or `augroup+`. Set it to `nil` to define
+  `autocmd`s affiliated with no augroup.
 
 See [`augroup!`](#augroup) for the rest.
 
@@ -505,7 +505,7 @@ Aliases of [`setglobal!`][setglobal], [`setglobal+`][setglobal], and so on.
 
 #### `bo!`
 
-Set a buffer option value. `:h nvim_buf_set_option`.
+Set a buffer option value. `:h nvim_buf_set_option()`.
 
 ```fennel
 (bo! ?id name value)
@@ -537,7 +537,7 @@ call setbufvar(10, '&buftype', 'nofile')
 
 #### `wo!`
 
-Set a window option value. `:h nvim_win_set_option`.
+Set a window option value. `:h nvim_win_set_option()`.
 
 ```fennel
 (wo! ?id name value)
@@ -609,6 +609,8 @@ Map `lhs` to `rhs` in `modes` recursively.
 - `modes`: (string|string[]) Mode short-name (map command prefix: "n", "i", "v",
   "x", …) or "!" for `:map!`, or empty string for `:map`.
 - [`?extra-opts`](#extra-opts): (bare-sequence) Additional option:
+  - `remap`: Make the mapping recursive. This is the inverse of the "noremap"
+    option from `nvim_set_keymap()`.
   - `literal`: Disable `replace_keycodes`, which is automatically enabled when
     `expr` is set in `extra-opts`.
   - `<buffer>`: Map `lhs` in current buffer by itself.
@@ -624,7 +626,7 @@ Map `lhs` to `rhs` in `modes` recursively.
   as Lua function; otherwise, as Normal mode command execution.
 
   Note: Insert `<command>` key in `extra-opts` to set string via symbol.
-- [`?api-opts`](#api-opts): (kv-table) `:h nvim_set_keymap`.
+- [`?api-opts`](#api-opts): (kv-table) `:h nvim_set_keymap()`.
 
 #### `noremap!`
 
@@ -970,7 +972,7 @@ Create a user command.
   letter.
 - `command`: (string|function) Replacement command.
 - [`?api-opts`](#api-opts): (kv-table) Optional command attributes. The same as
-  `opts` for `nvim_create_user_command`.
+  `opts` for `nvim_create_user_command()`.
 
 ```fennel
 (command! :SayHello
@@ -1037,7 +1039,7 @@ Set a highlight group.
 
 - `?ns-id`: (number) Namespace id for this highlight `nvim_create_namespace()`.
 - `name`: (string) Highlight group name, e.g., "ErrorMsg".
-- `val`: (kv-table) Highlight definition map. `:h nvim_set_hl`. As long as the
+- `val`: (kv-table) Highlight definition map. `:h nvim_set_hl()`. As long as the
   keys are bare-strings, `cterm` attribute map can contain `fg`/`bg` instead of
   `ctermfg`/`ctermbg` key.
 
@@ -1081,7 +1083,7 @@ It could be an unexpected behavior that `autocmd` whose callback ends with
 
 - Fennel `list` returns the last value.
 - `pcall` returns `true` when the call succeeds without errors.
-- `nvim_create_autocmd` deletes itself when its callback function returns
+- `nvim_create_autocmd()` deletes itself when its callback function returns
   `true`.
 
 ##### Anti-Pattern
@@ -1113,8 +1115,8 @@ It could be an unexpected behavior that `autocmd` whose callback ends with
 #### Nested anonymous function in callback
 
 `$` in the outermost hash function represents the single table argument from
-`nvim_create_autocmd`; on the other hand, `$` in any hash functions included in
-another anonymous function is meaningless in many cases.
+`nvim_create_autocmd()`; on the other hand, `$` in any hash functions included
+in another anonymous function is meaningless in many cases.
 
 ##### Anti-Pattern
 

fnl/nvim-laurel/macros.fnl

@@ -211,18 +211,12 @@
 (lambda option/modify [api-opts name ?val ?flag]
   (let [name (if (str? name) (name:lower) name)
         interface (match api-opts
-                    {:scope nil :buf nil :win nil}
-                    `vim.opt
-                    {:scope :local}
-                    `vim.opt_local
-                    {:scope :global}
-                    `vim.opt_global
-                    {: buf :win nil}
-                    (if (= 0 buf) `vim.bo `(. vim.bo ,buf))
-                    {: win :buf nil}
-                    (if (= 0 win) `vim.wo `(. vim.wo ,win))
-                    _
-                    (error* (.. "invalid api-opts: " (view api-opts))))
+                    {:scope nil :buf nil :win nil} `vim.opt
+                    {:scope :local} `vim.opt_local
+                    {:scope :global} `vim.opt_global
+                    {: buf :win nil} (if (= 0 buf) `vim.bo `(. vim.bo ,buf))
+                    {: win :buf nil} (if (= 0 win) `vim.wo `(. vim.wo ,win))
+                    _ (error* (.. "invalid api-opts: " (view api-opts))))
         opt-obj `(. ,interface ,name)
         ?val (if (and (contains? [:formatoptions :shortmess] name)
                       ;; Convert sequence of table values into a sequence of
@@ -528,6 +522,7 @@
                                           :<command>
                                           :cb
                                           :<callback>
+                                          :remap
                                           :noremap
                                           :nowait
                                           :silent
@@ -596,10 +591,12 @@
   @param ?api-opts kv-table"
   (when (and extra-opts.expr (not= false extra-opts.replace_keycodes))
     (set extra-opts.replace_keycodes (if extra-opts.literal false true)))
-  (when (and extra-opts.callback (not extra-opts.expr)
-             (or (nil? ?api-opts)
-                 (and (not ?api-opts.expr)
-                      (not (hidden-in-compile-time? ?api-opts)))))
+  (when (or extra-opts.remap
+            (and extra-opts.callback (not extra-opts.expr)
+                 (or (nil? ?api-opts)
+                     (and (not ?api-opts.expr)
+                          (not (hidden-in-compile-time? ?api-opts))))))
+    (set extra-opts.remap nil)
     (set extra-opts.noremap nil))
   (let [?bufnr extra-opts.buffer
         api-opts (merge-api-opts (keymap/->compatible-opts! extra-opts)

tests/spec/keymap_spec.fnl

@@ -59,7 +59,13 @@
           #(let [modes [:n :t :o]]
              (noremap! modes :lhs :rhs)
              (each [_ mode (ipairs modes)]
-               (assert.is.same :rhs (get-rhs mode :lhs)))))))
+               (assert.is.same :rhs (get-rhs mode :lhs)))))
+        (it "maps recursively with `remap` key in `extra-opts`"
+          #(let [modes [:n :o :x]]
+             (noremap! modes [:remap] :lhs :rhs)
+             (each [_ m (ipairs modes)]
+               (let [{: noremap} (get-mapargs m :lhs)]
+                 (assert.is.same 0 noremap)))))))
     (describe :map!
       (fn []
         (it "maps lhs to rhs with `noremap` set to `false` represented by `1`"