A Sublime Text 2/3 plugin for Haskell. Features cabal building, error and warning highlighting, smart completion and ghc-mod integration.
Python JavaScript Haskell
Latest commit 56e2007 Aug 26, 2016 @mvoidex mvoidex Some fixes
Permalink
Failed to load latest commit information.
Commands Added Hover.gif, version 1.0.3 Jul 11, 2016
Completions Restructured a bit. Nov 20, 2013
Icons Added mark icons; hasky theme: error/warning/hint colors Apr 22, 2016
Keymaps Commands moved to commands module Jul 9, 2016
Menus Allow go to hackage from context menu on source file Jan 19, 2015
Messages Added Hover.gif, version 1.0.3 Jul 11, 2016
Settings Move hsdev cache to `sublime.cache_path()` Jul 2, 2016
Snippets Added Double import snippet Oct 17, 2014
Syntaxes Added showing popup on hover over symbol and over gutter with hint/wa… Jul 11, 2016
Themes Fixed docs popup, normalising path case in ERRORS Jul 11, 2016
.gitignore Showing messages with show_sublime_message_process Feb 11, 2013
.hgignore Ignore Sublime files. Apr 5, 2012
.no-sublime-package Unzip this package Aug 25, 2013
LICENSE.txt Renamed the license file, which was inexplicably called README. Mar 3, 2012
Makefile Add Makefile with check target to be run before commits Jan 12, 2013
README.md Readme: added image with packagecontrol downloads Jul 12, 2016
autobuild.py Don't invoke ghc-mod check/lint if it's disabled, show status message… Jul 2, 2016
autocomplete.py Commands moved to commands module Jul 9, 2016
build.py Commands moved to commands module Jul 9, 2016
cabal.py Commands moved to commands module Jul 9, 2016
check_lint.py Commands moved to commands module Jul 9, 2016
commands.py Added showing popup on hover over symbol and over gutter with hint/wa… Jul 11, 2016
fix_syntax.py added utf-8 coding declaration to all .py files Jan 21, 2015
hdevtools.py Replaced <tool>_enabled with direct get_setting_async Jul 9, 2016
hsdev.py Commands moved to commands module Jul 9, 2016
info_popup.py Fixed docs popup, normalising path case in ERRORS Jul 11, 2016
messages.json Added Hover.gif, version 1.0.3 Jul 11, 2016
parseoutput.py Fixed docs popup, normalising path case in ERRORS Jul 11, 2016
repl.py Commands moved to commands module Jul 9, 2016
stylishhaskell.py Fixed PEP8 warnings/errors Jul 2, 2016
sublime_haskell_common.py Some fixes Aug 26, 2016
symbols.py Fixed docs popup, normalising path case in ERRORS Jul 11, 2016
types.py Fixed typo in types panel name Jul 11, 2016
worker.py Some fixes Aug 26, 2016

README.md

README

Package Control Join the chat at https://gitter.im/SublimeHaskell/SublimeHaskell PayPal Flattr this git repo

look

Requirements

Necessary:

  • ghc and a recent Haskell Platform (>= 2012 should do fine)
  • cabal
  • hsdev cabal package (cabal install hsdev) for inspection, enhanced completion, goto, symbol info etc.

Not necessary, but useful:

Deprecated:

  • ghc-mod (for import and LANGUAGE completions and type inference, cabal install ghc-mod, not used if hsdev enabled, ghc-mod is used by hsdev as a library)
  • hdevtools (or fork for windows) (for type inference, cabal install hdevtools, not used if hsdev enabled)

Binaries:

  • If your cabal, ghc-mod, ghc etc. are not installed in a system PATH, you have to adjust SublimeHaskell's add_to_PATH setting.

There are also special theme with enhanced haskell entities and marks (errors, warnings and hints) coloring
Note different coloring for types and constructors (in import list, data declaration etc.), special coloring of generic variables in types, pragmas and module imports

compare

Installation

  1. Get Sublime Text 2/3: http://www.sublimetext.com/
  2. Install the Sublime Package Control package: http://wbond.net/sublime_packages/package_control/installation
  3. Use Package Control to install this package (SublimeHaskell)

Usage

In short: Press shift-ctrl-p and type haskell to explore all commands.

When editing Haskell source files, automatic error highlighting and enhanced auto-completion is available.

Each time you save, any errors in your program will be listed at the bottom of the window and highlighted in the source code.

All source files in the project are scanned on change. Any symbols that they export are provided in the auto-complete suggestions.

Stylish-haskell can be used to stylish file or selected text.

Use f12 to go to declaration and ctrl+k ctrl+i to show symbol info with documentation. These command are also available through context menu with right-click.

To show inferred types use Show type (ctrl-k ctrl-h ctrl-t) command.

To insert inferred type use Insert type (ctrl-k ctrl-h ctrl-i).

You can jump between the errors and warnings with alt+d alt+e and alt+shift+d alt+shift+e. To show hidden error output, use command Show error panel (ctrl-alt-e)

Stack support

Build commands such as Build, Clean, Install, Rebuild uses stack if there is stack.yaml near .cabal. If you don't want to use stack, set haskell_build_tool setting to cabal.

hsdev uses stack to build dependencies and to get corresponding package-dbs. Since 0.1.7.2 it passes --compiler and --arch options to stack to get package-dbs built with hsdev-compatible compiler.

Enhanced completion

Works in export list (showing symbols in scope), import list, expressions. Completes after module qualifier (several modules can be import qualified as with same qualifier). Takes into account module reexports for sources. Autocompletion

Popup

Show popup with symbol info and with error/warning/hint details. Requires SublimeText 3 dev build > 3070. Hover

Commands:

  • SublimeHaskell: Insert import for symbol — add import for declaration InsertImport
  • SublimeHaskell: Find declarations — find declarations in installed packages and in projects
  • SublimeHaskell: Search declarations everywhere — search declarations in hayoo too
  • SublimeHaskell: Browse module — get declarations for module BrowseModule
  • SublimeHaskell: Browse declarations — get declarations in scope of current file
  • SublimeHaskell: Show symbol info — get help for symbol, ctrl+k ctrl+i
  • SublimeHaskell: Toggle symbol info panel — toggle continuout symbol info panel, which show info about symbol under cursor. Useful when reading code. SymbolInfo
  • SublimeHaskell: Go to module — go to module, ctrl+k ctrl+p GoToModule
  • SublimeHaskell: Go to declaration — overrides default, f12
  • Ctrl+R, Ctrl+Shift+R — overrides default, goto symbol and goto symbol in project
  • SublimeHaskell: Show type — show type/types for current expression, ctrl-k ctrl-h ctrl-t
  • SublimeHaskell: Expand selection to Expression — expand selection to expression, ctrl+shift+y
  • SublimeHaskell: Show/hide all types — get all types and highlight while selection modifies, ctrl+t, h Types
  • SublimeHaskell: Insert type — insert type for selected expression, ctrl-k ctrl-h ctrl-i
  • SublimeHaskell: Hayoo — search in hayoo
  • SublimeHaskell: Auto fix — auto fix some of warnings and/or errors (for now redundant imports and hlint hints) AutoFix
  • SublimeHaskell: Stylish — stylish source with stylish-haskell
  • SublimeHaskell: Scan docs and infer types — as long as scanning docs for sources and inferring types is long process, it's disabled by default, but this command can be used to scan docs and infer types for currently opened view
  • SublimeHaskell: Check & Lint — check/lint/check & lint opened file. Enable option check_lint_fly to check & lint on idle, rescanning actual source, so that completions are updated
  • Eval commands — see animation
    • SublimeHaskell: Eval selection — eval selected expression, for example
      • [1..10][1,2,3,4,5,6,7,8,9,10]
      • replicate 10 'a'aaaaaaaaaa (note no double quotes for string result)
    • SublimeHaskell: Apply to selection — same as above, but applies function to each selection
      • foobarreverseraboof
      • [1..10]reverse[10,9,8,7,6,5,4,3,2,1]
      • 1, 2, 3succ2, 3, 4
      • [1..3]intercalate ", " . map (\i -> "foo" ++ show i)foo1, foo2, foo3
    • SublimeHaskell: Apply to selection list — applies function to list made from selections
      • foo, bar, bazreversebaz, bar, foo
      • foo, bar, bazsortbar, baz, foo
  • Repl commands (uses SublimeREPL package)
    • SublimeHaskell Repl: GHCi — runs ghci
    • SublimeHaskell Repl: GHCi current file — runs ghci and loads current file
    • SublimeHaskell Repl: Cabal Repl — runs cabal repl for current project
    • SublimeHaskell Repl: Load — loads current file or project in repl
  • Context menu commands
    • Open package on Hackage — works within symbol info panel, opens Hackage page
    • Open module on Hackage — words in symbol info panel and in sources, opens Hackage page for selected module
  • Build commands
    • Build, Typecheck build (no codegen), Clean, Configure, Rebuild, Install, Test, Run
  • Error commands:
    • SublimeHaskell: Go to next error — go to next error in file, alt+d alt+e
    • SublimeHaskell: Go to previous error — go to previous error in file, alt+shift+d alt+shift+e
    • SublimeHaskell: Show error panel — show error panel if it was hidden, ctrl+alt+e

Build Systems

You don't have to use SublimeHaskell's built-in build functionality.

If you prefer, you can disable them in the settings, and use plain Sublime Build Systems:

cabal

Save this to your ~/.config/sublime-text-2/Packages/User/cabal-custom.sublime-build to make a custom cabal build system:

{
  "cmd": ["cabal build --ghc-options='-O0 -hidir o0 -odir o0'"],  // append lib:myPackage or myexecutable here to only build certain cabal targets
  "shell": true,
  "file_regex": "^(\\S*?):(\\d+):(\\d+):$"  // this matches the output of ghc
}

For more options, look here.

hdevtools

Save this to your ~/.config/sublime-text-2/Packages/User/hdevtools.sublime-build to make hdevtools a build system:

{
  "cmd": ["/home/USERNAME/.cabal/bin/hdevtools", "check", "-g", "-Wall", "$file"],
  "file_regex": "^(.*?):(\\d+):(\\d+):",
  "selector": "source.haskell"
}

Using build system results

You can then build with Ctrl-B and jump between the errors with (Shift-)F4.

It is also useful to add this to your key bindings to redisplay the error panel at any time:

  { "keys": ["ctrl+alt+b"], "command": "show_panel", "args": {"panel": "output.exec"} }

Using other useful projects with SublimeText

Jump-to-definition

There are two kinds of jump-to-definition: Inside your project and outside your project. In any case, install the Sublime CTags package via Package Control, and cabal install hasktags.

CTags expects the extended exuberant ctags format.

Inside your project: hasktags

  • In your project, hasktags --ctags --extendedctag .
  • You can now jump to definitions inside your project (Ctrl-T, Ctrl-T is the default keybinding)

Inside and outside your project: codex

codex allows you to use ctags to jump to definitions that are declared in your cabal dependencies.

  • cabal install codex
  • Run codex set format sublime, that updates your ~/.codex file to Sublime's Ctags plugin's format
  • Change ~/.codex to tagsFileName: .tags
  • In your project, codex cache clean && codex update
  • You can now jump to the source code of definitions outside of your project.
  • The commands CTags: Show Symbols and CTags: Rebuild Tags currently don't work with codex

Credits

Icons from FlatIcon.

Error icon by Eleonor Wang
Warning icon by Freepik
Hint icon by Gregor Cresnar