search

danchoi / ri_vim

Browse Ruby documentation inside Vim
http://danielchoi.com/software/ri_vim.html
MIT License
15 stars 1 forks source link

Compatibility with Vundle #1

Open soulnafein opened 13 years ago

soulnafein commented 13 years ago

Hello there,

I would love to use your plugin but I would love if it was Vundle compatible https://github.com/gmarik/vundle

I would like to make it part of https://github.com/soulnafein/vim-on-rails maybe you could fork it and install ri_vim there.

Thanks.

danchoi commented 13 years ago

Thanks for pinging me about this. What's the best way to learn how to make ri.vim compatible with Vunble?

soulnafein commented 13 years ago

Hello danchoi, I think I've managed to add ri_vim to vim on rails. I've installed the gem and instead of using your installation script. I'm not sure it works fine though, I think the default mappings colliding with the ruby-refactorings plugin one. Would you try vim-on-rails and let me know if the installation is ok?

(BTW it saves a backup of your .vim folder automatically and restores it when you do rake uninstall, so it's pretty easy and safe to try)

jfelchner commented 12 years ago

@danchoi There's nothing special you have to do to make it Vundle/Pathogen compatible, just get rid of the gem requirement and make it so that the git repo is based on a Vim plugin structure. For an example, just take a look at any of Tim Pope's plugins such as abolish.vim: https://github.com/tpope/vim-abolish

I'm sure any hard-coded paths will also need to be removed.

Any Ruby requirement should be a secondary step which is performed after the user installs the Vim plugin. That way we can use Vundle to always install our plugins (say on a remote system) but not necessarily be required to meet all the requirements of all plugins.

For an example of a plugin that requires a gem, look at Hammer which is also Vundle compatible: https://github.com/robgleeson/hammer.vim

Thanks for this plugin @danchoi it is very useful. Once this installation issue is taken care of I think you'll be all set for a 1.0 release.

danchoi commented 12 years ago

ok i'll try to work on this this weekend

jfelchner commented 12 years ago

@danchoi Thanks! You rock!

Just one point in particular, one of the main issues is the hard path you have in the compiled ri.vim file. Line 9. That doesn't work when a) I'm using RVM to manage my gems b) I deploy my vim files to a server where that path is different.

Thanks again!

danchoi commented 12 years ago

@jfelchner OK sorry for the delay, but I just took at crack at this just now. It's a new github project: https://github.com/danchoi/ri.vim

Thanks for the detailed guidance. It helped a lot. But I'm not 100% percent sure I got it right. Please let me know if I need to do more work to get this working. I haven't actually installed vundle or pathogen yet, but I plan to.

jfelchner commented 10 years ago

Anyone want to close this issue? It's obviously dead.

jfelchner commented 6 years ago

@soulnafein can we go ahead and close this out please?