feat: testing and configurable iterative mapping

.githooks/tests.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+make test

.github/workflows/tests.yml

@@ -0,0 +1,28 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+    branches:
+      - "main"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        nvim-versions: ['stable', 'nightly']
+    name: Plenary Tests
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+
+      - uses: rhysd/action-setup-vim@v1
+        with:
+          neovim: true
+          version: ${{ matrix.nvim-versions }}
+
+      - name: run tests
+        run: make test

.luarc.json

@@ -0,0 +1,7 @@
+{
+    "diagnostics.globals": [
+        "describe",
+        "it",
+        "before_each"
+    ]
+}

Makefile

@@ -0,0 +1,11 @@
+TESTS_INIT=tests/minimal_init.lua
+TESTS_DIR=tests/
+
+.PHONY: test
+
+test:
+	@nvim \
+		--headless \
+		--noplugin \
+		-u ${TESTS_INIT} \
+		-c "PlenaryBustedDirectory ${TESTS_DIR} { minimal_init = '${TESTS_INIT}' }"

lua/hawtkeys/init.lua

@@ -1,25 +1,69 @@
 local M = {}
+
+---@alias SupportedKeyboardLayouts "qwerty" | "dvorak"
+
+---@class HawtKeyConfig
+---@field leader string
+---@field homerow number
+---@field powerFingers number[]
+---@field keyboardLayout SupportedKeyboardLayouts
+---@field customMaps { [string] : TSKeyMapArgs | WhichKeyMapargs } | nil
+
+---@class HawtKeyPartialConfig
+---@field leader string | nil
+---@field homerow number | nil
+---@field powerFingers number[] | nil
+---@field keyboardLayout SupportedKeyboardLayouts | nil
+---@field customMaps { [string] : TSKeyMapArgs | WhichKeyMapargs } | nil
+---
+
+---@type { [string] : TSKeyMapArgs | WhichKeyMapargs }---
+
+M._defaultSet = {
+    ["vim.keymap.set"] = {
+        modeIndex = 1,
+        lhsIndex = 2,
+        rhsIndex = 3,
+        optsIndex = 4,
+        method = "dot_index_expression",
+    }, --method 1
+    ["vim.api.nvim_set_keymap"] = {
+        modeIndex = 1,
+        lhsIndex = 2,
+        rhsIndex = 3,
+        optsIndex = 4,
+        method = "dot_index_expression",
+    }, --method 2
+    ["whichkey.register"] = {
+        method = "which_key",
+    }, -- method 6
+}
+
+---@param config HawtKeyPartialConfig
 function M.setup(config)
     config = config or {}
     M.leader = config.leader or " "
     M.homerow = config.homerow or 2
     M.powerFingers = config.powerFingers or { 2, 3, 6, 7 }
     M.keyboardLayout = config.keyboardLayout or "qwerty"
-    vim.api.nvim_create_user_command(
-        "Hawtkeys",
-        "lua require('hawtkeys.ui').show()",
-        {}
-    )
-    vim.api.nvim_create_user_command(
-        "HawtkeysAll",
-        "lua require('hawtkeys.ui').show_all()",
-        {}
-    )
-    vim.api.nvim_create_user_command(
-        "HawtkeysDupes",
-        "lua require('hawtkeys.ui').show_dupes()",
-        {}
-    )
+    M.keyMapSet =
+        vim.tbl_extend("force", M._defaultSet, config.customMaps or {})
 end
 
+vim.api.nvim_create_user_command(
+    "Hawtkeys",
+    "lua require('hawtkeys.ui').show()",
+    {}
+)
+vim.api.nvim_create_user_command(
+    "HawtkeysAll",
+    "lua require('hawtkeys.ui').show_all()",
+    {}
+)
+vim.api.nvim_create_user_command(
+    "HawtkeysDupes",
+    "lua require('hawtkeys.ui').show_dupes()",
+    {}
+)
+
 return M

lua/hawtkeys/tests/set_maps.lua

@@ -0,0 +1,51 @@
+vim.api.nvim_set_keymap(
+    "n",
+    "<leader>1",
+    ':lua print("1 pressed")<CR>',
+    { noremap = true, silent = true }
+)
+vim.keymap.set(
+    "n",
+    "<leader>2",
+    ':lua print("2 pressed")<CR>',
+    { noremap = true, silent = true }
+)
+
+local normalMap = function(lhs, rhs)
+    vim.api.nvim_set_keymap("n", lhs, rhs, { noremap = true, silent = true })
+end
+normalMap("<leader>3", ':lua print("3 pressed")<CR>')
+
+local shortIndex = vim.api
+
+shortIndex.nvim_set_keymap(
+    "n",
+    "<leader>4",
+    ':lua print("4 pressed")<CR>',
+    { noremap = true, silent = true }
+)
+
+local shortFunc = vim.api.nvim_set_keymap
+
+shortFunc(
+    "n",
+    "<leader>5",
+    ':lua print("5 pressed")<CR>',
+    { noremap = true, silent = true }
+)
+
+local whichkey = require("which-key")
+
+whichkey.register({
+    ["<leader>"] = {
+        ["6"] = { ':lua print("6 pressed")<CR>', "Print 6" },
+        ["7"] = { ':lua print("7 pressed")<CR>', "Print 7" },
+    },
+})
+
+return {
+    "plugin/example",
+    keys = {
+        { "<leader>8", ":lua print('8 pressed" },
+    },
+}

lua/hawtkeys/tests/test_ts.lua

@@ -0,0 +1,5 @@
+local ts = require("hawtkeys.ts")
+
+local maps = ts.find_maps_in_file("lua/hawtkeys/tests/set_maps.lua")
+print(vim.inspect(maps))
+ts.reset_scanned_files()