elm-format
github.com
- Free plan
- Windows
- macOS
- Linux
What elm-format is
elm-format is a free, open-source command-line formatter for Elm. It applies rules based on the official Elm Style Guide and can process one file or every Elm file in a directory. The --yes option allows files to be overwritten. Installation is documented through npm install -g elm-format or downloadable release binaries. The tool should run from a directory containing elm.json or elm-package.json, or receive the matching Elm version option. Release 0.8.7 provides binaries for Linux, macOS, and Windows. Editor integrations are listed for Atom, Light Table, Vim, Emacs, Visual Studio Code, Sublime Text, JetBrains IDEs, and TextMate. Prettier support is available through prettier-plugin-elm, and approved plugins format files on save by default. The project describes consistent formatting as helping Elm code stay easier to write, read, and maintain while reducing team debates. It supports Elm only, includes a library API, and uses the BSD-3-Clause license. The listed plan is free.
Who it suits
It suits Elm developers and teams that want consistent source formatting from the command line or editor. It also fits projects using the listed operating systems and editor integrations.
Good to know, and what to watch
- Free and open source under BSD-3-Clause
- Formats individual files or whole directories
- Offers editor integrations and format-on-save behavior
- Provides Linux, macOS, and Windows binaries
- Includes a library API
- Supports Elm only
- Command-line use requires Elm project metadata or version option
- Overwrite behavior requires the --yes option
- Latest listed release is 0.8.7
Plans
Every plan and priceelm-format
Free plan
The verdict
elm-format is a focused formatter for teams maintaining Elm code. Its command-line workflow, editor integrations, and free open-source license make adoption straightforward where Elm is the target language.
What the maker publishes
- Command line
- The command line can format a single Elm file or all Elm files in a directory, and can overwrite files with the --yes option. source
- Consistent style
- The project says consistent formatting can make code easier to write, read, and maintain, and reduce team debates about formatting. source
- Editor integrations
- The README lists integrations for Atom, Light Table, Vim, Emacs, Visual Studio Code, Sublime Text, JetBrains IDEs, and TextMate. source
- Elm versions
- The README says to run elm-format from a directory containing elm.json or elm-package.json, or pass the corresponding Elm version option. source
- Format on save
- The README says the default behavior of elm-format-approved plugins is to format Elm files on save. source
- Install
- The README documents installation with npm install -g elm-format or by downloading a release binary. source
- Intended users
- The README describes benefits for developers and teams writing and maintaining Elm code. source
- License
- The repository identifies its license as BSD-3-Clause. source
- Operating systems
- The 0.8.7 release provides binaries for Linux, macOS, and Windows. source
- Other tool integration
- The README lists integration with Prettier through prettier-plugin-elm. source
- Purpose
- elm-format formats Elm source code according to rules based on the official Elm Style Guide. source
- Release
- The latest release page opened is version 0.8.7, released on April 11, with fixes and improvements including a Windows npm installer fix. source
- Signing
- The 0.8.7 release page says its tag was signed with a verified committer signature and that the signing key has expired. source
Checked against the maker's pages on 8 Oct 2026.