search

dscleaver / sbt-quickfix

SBT plugin that routes compiler and test errors into a quickfix file
Other
55 stars 28 forks source link

Improving Documentation #2

Open Jentsch opened 11 years ago

Jentsch commented 11 years ago

Hi, this plug-in sounds very nice. None-Vim experts (e.g. me) are unable to get the Vim quickfix running by the Readme.

I think this could be also a problem for others. Could you elaborate this a little bit more inside the Readme.md?

Vim answers :cc1 with "No Error", but a target/quickfix/sbt.quickfix with a reported error exists.

Thanks, Jentsch

dscleaver commented 11 years ago

Sorry to not get back to you sooner, but I've been sick most of this week. There is documentation in VIM once you have the VIM plugin installed following the directions in the Readme. I'm not sure I qualify as a VIM expert, but I simply use the ff and fn bindings defined in the VIM plugin. You should at least do ff before attempting to use other quickfix commands. Would adding a link to quickfix documentation help? http://vimdoc.sourceforge.net/htmldoc/quickfix.html

pjrt commented 10 years ago

I'm on the same boat. I can't get it to work.

I used Vundle instead of Pathogen.

I'm not sure where to run the command sbt install-vim-plugin. Can't run it in my project (no such task error).

My vim is not compiled with +clientserver, but mvim (MacVim) is. Does that matter?

EDIT: Using the 0.3.1 version since we are pre 0.13

dscleaver commented 10 years ago

Where do you have the sbt-quickfix plugin declared?

Once that is properly being used in your global or project configuration, then you should be able to run the install-vim-plugin command from within sbt.

pjrt commented 10 years ago

It is in my ~/.sbt/plugins/plugins.sbt

I guess I should have also mentioned that this is a multi-project project. This can cause issues pre-13 since the "root" project is not explicit. So it might be in my root project (whatever that is) or not. Maybe I should upgrade to 13 and try again.

galaux commented 10 years ago

Very nice project! Thanks a lot. I would "+1" on the suggestion of improving the documentation though. I had hard time finding out the vim plugin you are refering to is not this one but the one you provide on the src directory. To be cleaner I would even extract the vim plugin into its own repository and tell people to install it using whatever way they are used to (cloning the repo, using Pathogen, Vundle, …) Lastly: In order for vim to be made aware of error changes, I need to run vim with --servername GVIM

dscleaver commented 10 years ago

Thanks for the suggestion. I'm going to look into providing some improved documentation. The logic for maintaining the vim-plugin within this project is to handle changes that need to occur in both and may be dependent on one another. The install command then makes it easy to put it in the right place.