m4xshen/hardtime.nvim

• Block repeated keys within a short period of time
• Provide hints for faster Vim motion
• Get report of your most common bad habits

Instead of only relying on hjkl, arrow keys and mouse, you should:

1. Use relative jump (eg: 5j 12-) for vertical movement within the screen.
2. Use CTRL-U CTRL-D CTRL-B CTRL-F gg G for vertical movement outside the screen.
3. Use word-motion (w W b B e E ge gE) for short-distance horizontal movement.
4. Use f F t T , ; 0 ^ $ for medium to long-distance horizontal movement.
5. Use operator + motion/text-object (eg: ci{ y5j dap) whenever possible.
6. Use % and square bracket commands (see :h [) to jump between brackets.

Learn more in this blog post

• Neovim >= v0.10.0

1. Install via your favorite package manager.

{
   "m4xshen/hardtime.nvim",
   lazy = false,
   dependencies = { "MunifTanjim/nui.nvim" },
   opts = {},
},

1. Setup the plugin in your init.lua. This step is not needed with lazy.nvim if opts is set as above.

require("hardtime").setup()

If you want to see the hint messages in insert and visual mode, set the 'showmode' to false.

But if you want to see both the hint message and current mode you can setup with one of the following methods:

• Display the mode on status line and set 'showmode' to false. You can do this with some statusline plugin such as lualine.nvim.
• Set the 'cmdheight' to 2 so that the hint message won't be replaced by mode message.
• Use nvim-notify to display hint messages on the right top corner instead of commandline.

Hardtime is enabled by default. You can change its state with the following commands:

• :Hardtime enable enable Hardtime
• :Hardtime disable disable Hardtime
• :Hardtime toggle toggle Hardtime

You can view the most frequently seen hints with :Hardtime report.

Your log file is at ~/.local/state/nvim/hardtime.nvim.log.

You can pass your config table into the setup() function or opts if you use lazy.nvim.

If the option is a table (key = value pair), you can set value to false to disable the default value.

Examples:

disabled_keys = {
   ["<Up>"] = false, -- Allow <Up> key
   ["<Space>"] = { "n", "x" }, -- Disable <Space> key in normal and visual mode
},

disabled_filetypes = { 
   lazy = false, -- Enable Hardtime in lazy filetype
   ["dapui*"] = false, -- Enable Hardtime in filetype starting with dapui
},

These are two default hints:

hints = {
   ["k%^"] = {
      message = function()
         return "Use - instead of k^" -- return the hint message you want to display
      end,
      length = 2, -- the length of actual key strokes that matches this pattern
   },
   ["d[tTfF].i"] = { -- this matches d + {t/T/f/F} + {any character} + i
      message = function(keys) -- keys is a string of key strokes that matches the pattern
         return "Use " .. "c" .. keys:sub(2, 3) .. " instead of " .. keys
         -- example: Use ct( instead of dt(i
      end,
      length = 4,
   },
}

Check out some examples of custom hint in discussion!

Please read CONTRIBUTING.md.