Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
The Haskell IDE for Emacs.
Emacs Lisp
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
examples
lib
src
README.md

README.md

ALPHA — don't try to use!

I'm still working on it. See the issue tracker for upcoming features and bugs. Please wait until test-cases (see “Complete unit testing” milestone) have been written before contributing patches.

CONTRIBUTING

Feedback

I kinda avoided asking for feedback because I have a lot of stuff planned and bugs to fix still. If anyone wants to create tickets (dunno if you guys can create milestones) for any neat ideas you have (not guaranteed to be implemented by me but good to put in a tangible list):

Developing

  • Patches welcome, but do it in a dev branch, not the master branch
  • Not interested in "I fixed indentation and removed whitespace/I refactored X" patches at the moment. Only commit hunks related to a real bugfix or new feature change.
  • Please make small, isolated patches and preferably open a ticket and associate your commit(s) with the ticket so that we have a history trace.
  • Make sure your patches work with emacs -Q -l examples/init.el, this is a good test to check you're not making any assumptions and devs and users can still try and test easily.

Architecture-wise, your main points of interest are:

Most things start in hs-mode, hs-interactive-mode and hs-process.

QUICK TRY (includes dependencies, just run it :-)

It's a bit early days, but the brave who can put up with weirdness and alpha code can try:

$ cabal install hasktags
$ emacs -nw -Q -l examples/init.el

See examples/init.el for example bindings.

I will include auto-complete and auto-complete-etags.el (and any other dependencies) in the distribution in future.

DONE

  • Figuring out project from .cabal file
  • Named sessions
  • Collapsed/reduced error messages.
  • Multi-line expressions
  • Cabal build/configure/upload/etc
  • Type of symbol at point based on active GHCi session
  • Completion based on current module
  • Completion based on whole project
  • Jump to definition
  • Go to error/warning line and column
  • In-console completion
  • Automatic synchronization with GHCi session (via cabal-dev)
  • Sort imports alphabetically
  • Align imports up nicely
  • Cabal file editing
  • Cabal-dev local-repository support
  • Language/option/keyword completion
  • Move nested blocks of code around
  • Jump to/back-from import list for quick editing
  • Type of symbol at point (non-local)
  • Type error handling (in REPL, brings up an error buffer)
  • Auto-insert LANGUAGE pragmas based on GHCi errors
  • Meagre imenu support
  • Creation of base Cabal projects
  • Preliminary loading of files in GHCi with a separate GHCi session, this avoids losing type information on a failed compile

TODO — EASY / TRIVIALLY SPECIFIED

  • Indentation that doesn't suck, including indenting/deindenting whole blocks automatically
  • GHCi interaction
    • Syntax-highlighted prompt
    • Show-based value inspection
    • Module awareness
  • Cabal integration
    • Configuration
    • Automatic dependency inserting
    • Interactive creation/management of Cabal file
  • Source code editing
    • Haskell-aware code-folding
    • Documentation of symbol at point
  • Module import-export awareness
    • Completion based on:
    • imported modules
    • installed modules with automatic importation and Cabal-file dependency adding
    • Automatic importation and de-importation of modules for used symbols
    • Hoogle search support
    • Hayoo search support
  • Automake/correctness checking
    • Compilation on an interval
    • On-the-fly hint suggestions
  • Documentation browsing
    • Ability to browse Haddock documentation inside Emacs (possibility for texinfo here)

TODO — NOT SURE / TRICKY / NONTRIVIALLY SPECIFIED

  • GHCi interaction
    • Debugger tracebacks
  • Source code editing
    • Truly syntax-aware editing
    • Binding tracking
    • Syntax-aware indentation choices
    • Inability to write syntactically incorrect code
    • Type of symbol at point (local)
Something went wrong with that request. Please try again.