elm-review/README.md

elm-lint

An Elm linter written in Elm.

Try it

This is a prototype, so there is no CLI yet, but you can test elm-lint online here. Enter your source code in the top-left box, and see the reported errors in the bottom-left box.

Please note that the tool that analyzes your code has parsing issues and valid code may not be considered as such.

What does this tool do?

elm-lint analyzes your Elm source code, and tries to recognize patterns that may be considered harmful. If you are familiar with ESLint from JavaScript, this is pretty much the same idea.

You can read the slides for my presentation of this tool to learn more about it.

Rules

• NoUnusedVariables - Reports variables that are declared but never used.
• NoDebug - Forbid the use of Debug before it goes into production.
• NoDuplicateImports - Forbid importing the same module several times in a file.
• NoUnannotatedFunction - Ensure every top-level function declaration has a type annotation.
• NoExposingEverything - Forbid exporting everything in your modules module Main exposing (..), to make your module explicit in what it exposes.

More rule ideas in this slide and the ones below it. Note that some rules were implemented but may not be good ideas. Think for yourself and ask the community whether you should enable them.

MIT © Jeroen Engels