jinja.vim icon indicating copy to clipboard operation
jinja.vim copied to clipboard

Plugin pulls other modules from GitLab without warning

Open savchenko opened this issue 9 months ago • 2 comments

Large, bold warning would be very much appreciated. Or, even better — disable this behaviour by default.

Readme says:

"The plugin repository does define some Git submodules, but they are only needed if you want to run tests."

I have not tried to run any.

savchenko avatar Apr 19 '25 03:04 savchenko

Or, even better — disable this behaviour by default.

I am open to suggestions, but to me this seems like a plugin manager problem. I have made the note more prominent for now.

HiPhish avatar Apr 19 '25 07:04 HiPhish

OK, this might be a simplistic solution, but here are two ideas:

  1. Provide appropriate snippets for users of common plugin managers. For example:

    {
        url = 'https://github.com/HiPhish/jinja.vim',
        submodules = false -- change to `true` if you intend to run tests
    }
    
  2. Replace .gitmodules with a shell snippet to clone yo-dawg.nvim and nvim-busted-shims.git

savchenko avatar Apr 19 '25 08:04 savchenko

I have given the issue some time, and I think user convenience is more important than contributor convenience (within reason of course). My solution is to rename the .gitmodules file to .submodules so plugin managers don't pick it up. Now each contributor has to run ls -s .submodules .gitmodules once. I think this is an acceptable compromise.

HiPhish avatar Jul 20 '25 18:07 HiPhish