nvim-mini / nvim-mini/mini.nvim

Persistent abbreviations

Open
#721 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

new-module
Dominant language
Lua
Stars
9.5k
Forks
310
Avg merge
4h 16m
Merged PRs (30d)
1

Description

Contributing guidelines
Module(s)

mini.abbrev

Description

Hello /

Often, while working in Vim, we make accidental typos. In such cases, we may create abbreviations to prevent future mistakes. This involves opening our configuration and creating said abbreviation by manually changing the text before and after, which can be really distracting:

vim.keymap.set([[!a]], [[flase]], [[false]])

The proposal would be the ability to create on-the-fly persistent abbreviations and (optionally) provide a way to manage them (remove, modify, and so on). The basic operation would be to select the word we wish to correct and then press <leader>... to prompt the user for corrections (by which an abbreviation is created and persisted on confirmation). Mini.pick can take over from there by listing our abbreviations while mapping some key to (delete, add, change).

e.g.

image

Let me know what you think!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the mini.abbrev module and the proposed mini.pick management flow. Define how selecting a word creates a persistent abbreviation and how abbreviations can be removed or changed. Verify the completed behavior in Neovim using the example typo correction.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua, neovim
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.