Scala Java Lex Other
Clone or download

README.md

logo IntelliJ plugin for Haskell

Join the chat at https://gitter.im/intellij-haskell/Lobby

When I was learning Haskell, I missed the nice features of IntelliJ IDEA. My first approach was to use default way of creating an IntelliJ plugin by defining a grammar and a lexer according to Haskell report. That didn't work out because I could not define all the recursion. Then I decided to use grammar and lexer definitions only for tokenizing and parsing Haskell code, and not for syntax checking the code. This is needed for syntax highlighting, all kinds of navigation and so on. Further Haskell language support is provided with the help of external tools.

This plugin depends mainly on Stack and Intero. It can create new Stack projects (by using template hspec) and import existing Stack projects.

Any feedback is welcome!!

Installing the plugin

You can install this plugin using the Jetbrains plugin repository: Settings/Plugins/Browse repositories/Intellij-Haskell

To try out the latest beta version one can install the plugin by adding https://plugins.jetbrains.com/plugins/alpha/8258 as Custom plugin repository in Settings/Plugins/Browse repositories/Manage repositories.

Alternative way to install the latest beta version is to download intellij-haskell.zip from releases and apply Install plugin from disk in Settings/Plugins.

Features

  • Syntax highlighting;
  • Error/warning highlighting;
  • Find usages of identifiers;
  • Resolve references to identifiers;
  • Code completion;
  • In-place rename identifiers;
  • View type info from (selected) expression;
  • View sticky type info;
  • View expression info;
  • View quick documentation;
  • View quick definition;
  • Structure view;
  • Goto to declaration (called Navigate>Declaration in IntelliJ menu);
  • Navigate to declaration (called Navigate>Class in IntelliJ menu);
  • Navigate to identifier (called Navigate>Symbol in IntelliJ menu);
  • Goto instance declaration (called Navigate>Instance Declaration in IntelliJ menu);
  • Navigate to declaration or identifier powered by Hoogle (called Navigate>Navigation by Hoogle in IntelliJ menu);
  • Inspection by HLint;
  • Quick fixes for HLint suggestions;
  • Show error action to view formatted message. Useful in case message consists of multiple lines (Ctrl-F10, Meta-F10 on Mac OSX);
  • Intention actions to add language extension (depends on compiler error), add top-level type signature (depends on compiler warning);
  • Intention action to select which module to import if identifier is not in scope;
  • Code formatting with hindent, stylish-haskell, or both together. hindent can also be used to format a selected code block.
  • Code completion for project module names, language extensions and package names in Cabal file;
  • Running REPL, tests and executables via Run Configurations;

Usage with hindent

When used with hindent, intellij-haskell automatically sets --indent-size as a command-line option in hindent from the Indent option in your project code style settings. It also automatically sets the --line-length command-line option from your Right margin (columns) code style setting. This means that any .hindent.yaml files used for configuration will have these options overridden and may not fully work.

Getting started

  • If you don't already have IntelliJ, download it - the Community Edition is sufficient.
  • Install this plugin using the Jetbrains plugin repository: Settings/Plugins/Browse repositories/Intellij-Haskell. Make sure no other Haskell plugin is installed in IntelliJ;
  • Install latest version of Stack; use stack upgrade to confirm you are on the latest version.
  • Install latest versions of Hindent and Stylish-Haskell. You have to install version of Hindent > 5.0, for example by: stack install --resolver=nightly hindent stylish-haskell Set file paths to hindent and stylish-haskell in the Settings>Other Settings>Haskell;
  • Setup the project:
    • Make sure your Stack project builds without errors. Preferably by using: stack build --test --haddock --fast;
    • After your project is built successfully, import project in IntelliJ by using File>New>Project from Existing Sources... from the IntelliJ menu;
    • In the New Project wizard select Import project from external model and check Haskell Stack;
    • In next page of wizard configure Project SDK by configuring Haskell Tool Stack with selecting path to stack binary, e.g. /usr/local/bin/stack;
    • Finish wizard and project will be opened;
    • Wizard will automatically configure which folders are sources, test and which to exclude;
    • Plugin will automatically build Intero and HLint to prevent incompatibility issues (If you use non LTS or Nightly resolver e.g. ghc-7.10.2, you may have to build them manually since there are some extra-deps should be added to stack.yaml). Those tools are built against Stackage release defined in project's stack.yaml. If you want to use later version of tool, you will have to build tool manually in project's folder by using stack build;
    • Check Project structure>Project settings>Modules which folders to exclude (like .stack-work and dist) and which folders are Source and Test (normally src and test);
    • Plugin will automatically download library sources. They will be added as source libraries to module(s). This option gives you nice navigation features through libraries. Sources are downloaded to folder .intellij-haskell inside your home folder;
    • After changes to dependencies you can download them again by using Tools>Haskell>Download Haskell Library Sources;
    • The Event Log will display what's going on in the background. Useful when something fails. It's disabled by default. It can be enabled by checking Haskell Log checkbox in the Event Log>Settings or Settings>Appearance & Behavior>Notifications;
    • In the background for each Haskell project three Stack REPLs are running. You can restart them by Tools>Restart Haskell Stack REPLs.
    • When you make changes to stack.yaml or Cabal file, IntelliJ will give you notification with the option to restart REPLs;

Remarks

  1. About Haskell Project in Help menu shows which Haskell GHC/tools are used by plugin for project;
  2. Intero depends on libtinfo-dev. On Ubuntu you can install it with sudo apt-get install libtinfo-dev;

How to build project

  1. Clone this project;
  2. Go to root of project and start sbt;
  3. Run task updateIdea from the sbt console;
  4. Run task compile from the sbt console;
  5. Install/enable the following plugins in IntelliJ: Plugin Devkit, Grammar-Kit and PsiViewer;
  6. Import this project as an sbt project in IntelliJ;
  7. Be sure JVM SDK inside Languages & Frameworks>Scala Compiler Server is set to 1.8, since the Scala compiler version (2.12.3) which this plugin is currently using is not compatible with Java 7 or lower, Java 9 is not yet supported;
  8. Select Build>Build Project;

How to prepare plugin for deployment

  1. Right click on top of intellij-haskell.iml inside intellij-haskell folder;
  2. Select Import module;
  3. Be sure unmanaged-jars dependency is set to provided inside Project structure>Project settings>Modules>Dependencies (btw, setting provided inside sbt file gives error);
  4. Right click on top of intellij-haskell plugin module and select Prepare Plugin Module 'intellij-haskell' for deployment;

How to run/debug plugin inside IntelliJ

  1. Set Plugin SDK settings right inside Project structure>Platform settings>SDKs. For example to, set SDK home path to idea/142.5239.7 inside project root folder;
  2. Set Module-SDK right for intellij-haskell plugin module inside Project structure>Project structure>Project settings>Modules;
  3. To run plugin inside IntelliJ, first run configuration has to be created. Navigate to Run>Edit configurations and create plugin configuration for intellij-haskell;

Development remarks

  1. After making changes to _HaskellLexer.flex, run Run Flex Generator. This will generate _HaskellLexer.java;
  2. After making changes to haskell.bnf, run Generate Parser Code. This will generate parser Java files in gen directory;
  3. Add sources.zip inside idea>[idea build #] to Project structure>Project settings>Modules>Dependencies>unmanaged-jars to see IntelliJ sources;