A Sublime Text 3 plugin for Haskell. Features cabal building, error and warning highlighting, smart completion and ghc-mod integration.
Quick link ==> SublimeHaskell's Documentation
You will need to install either the GHC Haskell compiler and cabal
either stack
build tool and a backend before you install SublimeHaskell.
stack
will install ghc automatically, so there's no need to install GHC independently:
cabal
build tool):
cabal
should come pre-installed with your Haskell environment, e.g., if you installed the Haskell Platform.hsdev
. You can use one of the deprecated backends, but know that support for these backends may be dropped or removed in a future SublimeHaskell release.
cabal
— cabal install hsdev
stack
— create config (for example, hsdev.yaml
) with contents:
packages: []
resolver: lts-13.29
extra-deps:
- hsdev-0.3.3.1
- haddock-api-2.21.0
- hdocs-0.5.3.1
- network-3.0.1.1
And then run stack install hsdev --stack-yaml hsdev.yaml
cabal install ghc-mod
, not used if hsdev
enabled, ghc-mod
is used by hsdev
as a library)Open a Haskell source file, cabal
builder file or a stack.yaml
builder and have a productive Haskell development session!
stack
is a companion Haskell build tool that supplements cabal
.cabal install stylish-haskell
)cabal install hindent
)Tools (cabal
, hsdev
, ghc-mod
, ghc
, etc.) are usually installed in a directory that is already added to your PATH
environment variable. SublimeHaskell will also look for these tools in several "Haskell standard" places. These places include:
Builder | *nix Platforms | Windows |
---|---|---|
stack | $HOME/.local/bin |
%APPDATA%/local/bin |
cabal user | $HOME/.cabal/bin |
%APPDATA/cabal/bin |
cabal global | /usr/local/bin |
%PROGRAMFILES%/Haskell/bin |
More advanced users can configure cabal
's user and global install paths in $HOME/.cabal/config
. SublimeHaskell will use these values if configured and if the directories to which they refer exist.
If you have a non-standard installation location for your tools, you can configure this in SublimeHaskell's "User Settings" by adjusting add_to_PATH
. You will have to restart SublimeText after you save your preferences.
There is a 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
Open the SublimeText Command Palette ( Ctrl-Shift-P
or Option-Command-P
on OS X) and type haskell
to explore SublimeHaskell's goodness.
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 commands 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
)
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.
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.
Show popup with symbol info and with error/warning/hint details. Requires SublimeText 3 dev build > 3116 (https://forum.sublimetext.com/t/dev-build-3116/21148).
It also shows inferred type when possible
You can select all usages of symbol via link
And you can autofix warnings/hints on popup for warnings/hints
SublimeHaskell: Insert import for symbol
— add import for declaration
SublimeHaskell: Find declarations
— find declarations in installed packages and in projectsSublimeHaskell: Search declarations everywhere
— search declarations in hayoo tooSublimeHaskell: Browse module
— get declarations for module
SublimeHaskell: Browse declarations
— get declarations in scope of current fileSublimeHaskell: 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.
SublimeHaskell: Go to module
— go to module, ctrl+k ctrl+p
SublimeHaskell: Go to declaration
— overrides default, f12
Ctrl+R
, Ctrl+Shift+R
— overrides default, goto symbol and goto symbol in projectSublimeHaskell: 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
SublimeHaskell: Insert type
— insert type for selected expression, ctrl-k ctrl-h ctrl-i
SublimeHaskell: Hayoo
— search in hayooSublimeHaskell: Auto fix
— auto fix some of warnings and/or errors (for now redundant imports and hlint hints)
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 viewSublimeHaskell: 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
SublimeHaskell: Eval expression
— evaluate expression in context of current moduleSublimeHaskell: Expression type
— evaluate expression type in context of current moduleSublimeHaskell: 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
foobar
⫤ reverse
⤇ raboof
[1..10]
⫤ reverse
⤇ [10,9,8,7,6,5,4,3,2,1]
1
, 2
, 3
⫤ succ
⤇ 2
, 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
, baz
⫤ reverse
⤇ baz
, bar
, foo
foo
, bar
, baz
⫤ sort
⤇ bar
, baz
, foo
SublimeHaskell Repl: GHCi
— runs ghci
SublimeHaskell Repl: GHCi current file
— runs ghci
and loads current fileSublimeHaskell Repl: Cabal Repl
— runs cabal repl
for current projectSublimeHaskell Repl: Load
— loads current file or project in replOpen package on Hackage
— works within symbol info panel, opens Hackage pageOpen module on Hackage
— words in symbol info panel and in sources, opens Hackage page for selected moduleShow symbol usages
— show list of locations where symbol is usedBuild
, Typecheck build (no codegen)
, Clean
, Configure
, Rebuild
, Install
, Test
, Run
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
codex allows you to use ctags to jump to definitions that are declared in your cabal dependencies.
cabal install codex
codex set format sublime
, that updates your ~/.codex
file to Sublime's Ctags plugin's format~/.codex
to tagsFileName: .tags
codex cache clean && codex update
CTags: Show Symbols
and CTags: Rebuild Tags
currently don't work with codex
Icons from FlatIcon.
Error icon by Eleonor Wang
Warning icon by Freepik
Hint icon by Gregor Cresnar
Wrench icon by Gregor Cresnar