Skip to content

elm-tooling/intellij-elm

 
 

Repository files navigation

Elm Plugin for JetBrains IDEs

Provides support for the Elm programming language.

Should work on most, if not all, IntelliJ Platform IDEs: IDEA (Community and Ultimate), WebStorm, PyCharm, RubyMine and more. If not please raise an issue.

History

The original repo was klazuka/intellij-elm, created by Keith Lazuka and maintained together with AJ Alt. When Keith and AJ were unable to keep working on the plugin, the repo was later transferred to intellij-elm/intellij-elm, managed by Cies Breijs. After doing some incredible work on the plugin, Cies unfortunately disappeared from the community. Failing to reach him, the community forked the repo the elm-tooling organization (which is also home to the Elm Language Server). Then intention of this new home for the plugin is to not be tied to a single person and pass on the rights and maintenance responsibilities as contributors’ lives change.

Install

You may want to have some CLI tools --elm (the Elm compiler), elm-test, elm-format, elm-review and lamdera-- installed for certain features of this plugin to work.

You can install these globally with:

sudo npm install -g elm elm-test elm-format elm-review lamdera

NOTE: if you have node installed using nvm, make sure to read our NVM setup guide.

To install the plugin itself first make sure to uninstall all other Elm plugins you may have installed (this requires a restart of the IDE). Some have reported that having two Elm plugins installed results in the IDE not starting but showing a seemingly unrelated error (if you have this problem, there are ways to fix it).

From within a JetBrains IDE, go to Settings -> Plugins -> Marketplace and search for "Elm Language". If you get multiple hits look for the most recently updated version, since there are still older versions of the plugin available. After installing the plugin, restart the IDE and then open your existing Elm project or create a new project.

Alternatively you can install it manually by downloading a release (or downloading the source and building it yourself) and installing it with Settings -> Plugins -> ⚙️ (gear icon) -> Install plugin from disk...

Once the plugin is installed it is advised to double-check all CLI tools are found by going to Settings -> Languages & Frameworks -> Elm and see the CLI tools.

Features

Want to see it in action? This 10 minute video demonstrates many of the features and how they work together.

License

MIT licensed.

Contributing

Yes, please! See our guide on this topic.

About

Elm plugin for IntelliJ Platform IDEs

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Kotlin 98.2%
  • Elm 1.3%
  • Other 0.5%