Skip to content

Latest commit

 

History

History
99 lines (79 loc) · 4.59 KB

README.md

File metadata and controls

99 lines (79 loc) · 4.59 KB
Raw

vim-hs-type

This plugin has started as a fork of vim-hdevtools. It aims to improve getting type information ignoring every other abilities of hdevtools, cause they are better done by haskell-ide-engine.

Why is it better than vim-hdevtools?

  1. Interacting with types. Opened window contains types as a plain text, so you can interact with them as with a plain text.
  2. Multiple projects support. While vim-hdevtools stops only first started hdevtools server, vim-hs-type stops them all, even if they are in different projects and directories.
  3. Interacting with expressions. vim-hs-type supports ie and ae text objects (see Usage).
  4. More clean and readable code. Finally I've rewritten almost all the code. That's why this plugin is now split from the vim-hdevtools's forks tree.
  5. More customisation abilities. See Configuration.

Installation

There are to ways this plugin can access hdevtools. You can set 'hdevtools_from_stack' option to 1 (See Configuration) and then this command will be used by this plugin to run hdevtools:

stack exec --package hdevtools --no-ghc-package-path hdevtools

Otherwise you have to install hdevtools globally.

You can do it via stack from Stackage:

$ stack install hdevtools

or via cabal from Hackage:

$ cabal install hdevtools

Then use your favourite plugin manager to install vim-hs-type into Vim. For vim-plug:

Plug 'fimmind/vim-hs-type'

This plugin does not provide any default keybinding. I recommend to configure them for quick access to vim_hs_type#type(). Like that:

" .vimrc
autocmd FileType haskell nnoremap <buffer> <localleader>ht
      \ :call vim_hs_type#type()<CR>

or that:

" ftplugin/haskell.vim
nnoremap <buffer> <localleader>ht
      \ :call vim_hs_type#type()<CR>

You can replace <localleader>ht with any keybinding you like.

Usage

Main function of this plugin is vim_hs_type#type(). When you run it, a window containing all types of expressions under cursor is opened (You can close it with <Esc> or gq). Most likely in your case this won't look exactly the same, cause I have many other plugins installed, but for my setup it looks this way:

Moving cursor over lines causes highlighting of relevant expression in source code:

Also, text object of highlighted expression is available by ie and ae (latter also selects space around expression similarly to aw). You can, for example, delete current expression with die or select it with surrounding whitespace by vae.

Configuration

This plugin is configured via g:vim_hs_type_conf dictionary with such keys:

key description default
'max_height' Maximal height of opened window 12
'dynamic_height' Enable/Disable dinamic height 1
'path_to_hdevtools' Path to hdevtools executable 'hdevtools'
'hdevtools_args' Arguments passed to hdevtools []
'expression_obj' Letter or string for expression object 'e'
'highlight_group' Highlighting group for expressions in source code 'MatchParen'
'hdevtools_from_stack' If enabled, hdevtools runs from a stack's hdevtools package 0

So, if you, for example, want to disable dynamic height and stack integration and highlight expressions in source code with Visual group, add following to your vimrc:

let g:vim_hs_type_conf = {
      \ 'dynamic_height': 0,
      \ 'hdevtools_args': ['--nostack'],
      \ 'highlight_group': 'Visual'
      \ }

TODO

  • Write exhaustive documentation
  • Optionally run hdevtools' server on opening Haskell file, but not on first run of vim_hs_type#type()

LICENSE

  • MIT