wrapping a bash variable name in quotes

[rexroof]

Contributing guidelines

• I have read CODE_OF_CONDUCT.md

Module(s)

mini.ai, mini.surround

Question

One problem I'm regularly running into while maintaining bash scripts is a quick keystroke to surround a bash variable use in quotes. I have a neovim configuration mostly built around the mini modules so I'd be happy to add this config in the most mini-way possible.

I think what I need to do is write a mini.ai custom_textobject pattern that matches $VAR or ${VAR}? from searching the treesitter docs I don't believe that is a pre-existing textobject defined by treesitter?

Has anyone done this before, or is there a simpler solution that I'm not seeing?

Apologies if this is the wrong forum for a question like this, but I'm struggling to put together the pieces to solve this problem.

[echasnovski]

One problem I'm regularly running into while maintaining bash scripts is a quick keystroke to surround a bash variable use in quotes.
...
I think what I need to do is write a mini.ai custom_textobject pattern that matches $VAR or ${VAR}?

This indeed sounds like a correct direction: 1) create a custom 'mini.ai' textobject, like with v (variable) identifier; 2) use 'mini.surround' add mapping to surround the whole variable.

Here is how to create a custom 'mini.ai' textobject that would be active only in files with sh filetype (which bash scripts mostly are):

• Create a file ~/.config/after/ftplugin/sh.lua. This is a filetype plugin for for sh filetype. I'd also probably recommend copying the future contents of this file to ~/.config/after/ftplugin/bash.lua.

• Add the following lines to it:

  vim.b.miniai_config = {
    custom_textobjects = {
      -- Bash variable: $VAR, ${VAR}, $_VAR, $var, $_var123, etc.
      -- See `:h MiniAi-textobject-specification` for more details.
      v = { { '%$()[%a_][%w_]*()', '%${()[%a_][%w_]*()}' } },
    },
  }

Now opening the file with sh filetype (not necessarily the one that has *.sh extension, but the one which has :=vim.bo.filetype print sh) will have av select the whole variable (with $ and {}) and iv select the variable name.

Surrounding now is done by the following sequence: sa (surround add) - av (around variable) - " (double quote). If you want this to be something faster (although I'd recommend sticking to this type of explicit surrounding), you can create a buffer-local keymap by adding the following call to the filetype plugin(s):

vim.keymap.set('n', '<Leader>v', 'saav"', { buf = 0, remap = true })

Hope this helps!

---

Apologies if this is the wrong forum for a question like this, but I'm struggling to put together the pieces to solve this problem.

This is absolutely the intended use of the Q&A type of discussions here 👍

[rexroof]

Thank you so much! I experimented with an after/ftplugin like this but couldn't get the pattern quite right. and I debated if this was really the best place for it. this works like a charm!

I've been a fan of your work on neovim plugins for quite a few years, I really appreciate all of your contributions to the neovim ecosystem. I know that #917 exists, but I do wish there was a way I could donate monetarily!

[echasnovski]

I experimented with an after/ftplugin like this but couldn't get the pattern quite right.

Yeah, it is a bit overcomplicated, but it is quite flexible in return. I also had to read the help to remember the details about the patterns 😅️

I've been a fan of your work on neovim plugins for quite a few years, I really appreciate all of your contributions to the neovim ecosystem. I know that #917 exists, but I do wish there was a way I could donate monetarily!

Thank you so much for your kind words and wanting to donate! It means a lot!

Some aspects of enabling donations are (currently) not quite within my power. So we'll get there, when we get there :) In the meantime, using and sharing a word about the project is very much appreciated,