search

cespare / vim-toml

Vim syntax for TOML
MIT License
625 stars 40 forks source link

Please submit to upstream vim #36

Closed joshtriplett closed 3 years ago

joshtriplett commented 6 years ago

The rust.vim project ended up getting incorporated into vim itself, so that people have it available by default with a standard vim installation. See https://github.com/rust-lang/rust.vim/issues/134 and https://github.com/vim/vim/pull/1356 for details.

Please consider doing the same with vim-toml, to have vim provide a toml mode by default.

Thank you for vim-toml!

cespare commented 5 years ago

I think in my ideal world, TOML wouldn't change anymore, we could declare this plugin more or less "done" and contribute it to vim, and everyone could mostly stop thinking about it.

Several obstacles stand in the way.

  1. The quality of this plugin is not necessarily great, and it's not uniform. I review each patch as best I can, but after my initial commit it has largely been a sequence of individuals contributing small fixes for each issue they run across. Contributing this plugin to vim would likely involve upfront effort to improve its quality and make it match the vim standards.
  2. After contributing it to vim I would still be the maintainer, so (AFAIK regarding the vim contribution process) I would still need to review changes to the plugin, but they would need to go through vim's patch process. This adds more overhead for both me and contributors as compared with the current process.
  3. Related to (1): right now, I'm pretty accepting of changes -- if they look reasonable, I mostly accept them as-is, and later if there are problems we fix them up. Once toml is part of vim, I would feel greater responsibility to ensure that every patch that goes in is thoroughly vetted. Realistically, this probably means I would get around to doing this work much less often.
  4. TOML (unfortunately, in my view) keeps adding new syntax and features, so there are always new things that vim-toml doesn't know about. This means that I keep getting a slow, steady trickle of PRs and feature requests, and I expect that would continue after moving this plugin to vim. This exacerbates (2) and (3).
  5. I have very little time to devote to maintenance already, let alone doing the extra work implied by 1-3.

If some vim-toml user who also has some experience working with vim plugins would like to help with maintenance of vim-toml and shepherd vim-toml into the vim project, I'd certainly be open to that.

joshtriplett commented 5 years ago

@cespare I honestly don't feel like you need to do more on vim-toml to justify it being in vim. It's something many people use and depend on, and it works very well. That ought to be enough. I'd argue that (1) and (3) don't apply. (2) does, and I don't know the process there. (4) does, but slowly.

averms commented 5 years ago

If some vim-toml user who also has some experience working with vim plugins would like to help with maintenance of vim-toml and shepherd vim-toml into the vim project, I'd certainly be open to that.

@cespare I can help with that. I think I can whip up a test file, so we can make sure the syntax highlighting is working well and I might have an idea to fix #9.

averms commented 3 years ago

Yes I think that would be a good idea.

Of the issues @cespare raised:

  1. Not a problem anymore. Looking at syntax files in vim/vim (and as a maintainer of one of them) toml.vim is above average in code quality.
  2. The current repository's patch process will not be affected. You can open a pull request or just email Bram Moolenaar whenever you want to send any updates upstream.
  3. This is a valid concern but what you accept in this repository isn't immediately synced upstream. This repo can be like the alpha version of the syntax files in the Vim distribution.
  4. TOML 1.0.0 is out so hopefully no more features.
cespare commented 3 years ago

@89z "we" aren't going to do anything, unless you are volunteering to become a maintainer. You are asking me to do work, and apparently ignored the existing discussion.

averms commented 3 years ago

@89z "we" aren't going to do anything, unless you are volunteering to become a maintainer. You are asking me to do work, and apparently ignored the existing discussion.

I'm happy to become maintainer

cespare commented 3 years ago

@a-vrma

I'm happy to become maintainer

OK, sounds good. Thanks!

I added you to this repo. Feel free to update the files to list yourself as maintainer and me as the previous maintainer. Then I imagine you can submit upstream (but lmk if I need do to anything).

averms commented 3 years ago

I added you to this repo. Feel free to update the files to list yourself as maintainer and me as the previous maintainer.

Great, thanks!

I'm going to review both the pull requests, move all the hi def link lines in syntax/toml.vim to the bottom to match the style used by every other syntax file in the Vim repo, and then I'll open a pull request.

EDIT: vim/vim#8984

averms commented 3 years ago

Done as of vim/vim@28b6a3bef6d25d36c049bb731ced496155f7f9c0

cespare commented 3 years ago

Thanks very much @averms!