Usage instructions

[drwebb]

I set myself up with a shiny new neovim installation and installed this plugin via vim-plug. Pardon my ignorance, but I don't see any way to get started. Could we provide some usage instructions in the readme for the benefit of others?

[benarmston]

Hi drwebb, thanks for giving this plugin a try. You're absolutely right, the README could do with some better instructions. I'll list the steps that you can take to get started here and worry about getting them into the README later. I'm going to assume that you have the python3 bindings for nvim installed, if not, please install them.

1. Once the plugin is installed the next thing to do is start nvim and run the command UpdateRemotePlugins. This is a command which nvim needs to be run in order to know of the plugins existence.
2. Restart nvim so that it picks up the changes that have been made by UpdateRemotePlugins.

The above two steps are required by nvim (or at least the version of nvim that I'm running). There isn't anything that I can do to remove them.

1. Edit a Haskell file.
2. If everything goes well you will see a few messages in the status bar such as "Compiling Your.Module". If things don't go well, you might see some output in /tmp/stack_ide_debug.txt.

Assuming that everything has gone well, you have the following commands:

• GetExpTypes : this will show the type of the identifier under the cursor and highlight the identifier.
• ExpandExpTypes : this will expand the expression being highlighted and show its type.
• ClearExpTypesHighlight : this will remove the highlight.

I'm not sure they are the best descriptions possible, but you should understand what they do when you try them. The remaining command is:

• GetSpanInfo : this displays the project and module in which the identifier under the cursor is defined.

As you may have gathered from the README and the list of commands, this project is still quite early in its development. To be honest you may have better results with ghc-mod or similar.