Plugin canonical name: drop the 'vim-'. It's cleaner. about vim-maktaba HOT 5 CLOSED

Yeah, Nate and I were just discussing the fact that our vim plugins are going to start having name conflicts with other google github projects if we don't add a "vim-" prefix.

Sanity check: is it reasonable to say you can't have e.g. "unimpaired", "vim-unimpaired", and "unimpaired.vim" in the same ecosystem? We could keep the prefix/suffix in the "canonical" name and just allow the shorter name at lookup time in maktaba#plugin#Get, so if there really are distinct plugins distinguished by the "vim-" prefix or ".vim" suffix they're still usable. It's slightly more complex and could potentially get weird in some corner cases, but… just sayin'.

from vim-maktaba.

Yep, that is one valid approach, and I'm not opposed to it. But I'd be in favor of doing the simpler thing first (i.e., drop the vim). I don't know of any such conflicts currently existing. Also, I really don't think having separate plugins called "vim-unimpaired" and "unimpaired.vim" is something we'd want to encourage. (So basically: "yes, it's reasonable" to your sanity check above.)

from vim-maktaba.

The "vim-" prefix in "tpope/vim-surround" etc. is just a convention for GitHub repo names. The "official" plugin name is still surround.vim, this is used in the documentation, discussion on the issue tracker, the plugin page on vim.org, etc.

That's why I always strip the vim- when cloning:

$ git clone git://github.com/tpope/vim-surround.git ~/.vim/bundle/surround

But I agree that many people mistake the repo label for the plugin name these days.

(Just adding this here to make sure everybody is on the same page.)

from vim-maktaba.

Thanks for the helpful clarification.

I'll add that this confusion is reinforced by "fetching" plugin managers like Vundle, since they (quite sensibly) use the repo name as the directory name. Really, it hardly mattered before what the directory was called. But now, maktaba gives us actual named plugin objects, so it does matter.

Incidentally, this gives me an idea for the maktaba-based plugin manager I'm longing someday to see. It would be nice for it to name the directory after the CanonicalName by default.

And about surround.vim specifically: even though that's the official name, it still seems like we'd be better off dropping the .vim suffix. It seems awkward to carry it around. e.g. I find it more natural to write

Glaive surround options

rather than

Glaive surround.vim options

Maybe that's just me.

from vim-maktaba.

And about surround.vim specifically: even though that's the official name, it still seems like we'd be better off dropping the .vim suffix. It seems awkward to carry it around. e.g. I find it more natural to write

Glaive surround options

rather than

Glaive surround.vim options

Agreed.

from vim-maktaba.