exfmt 🌸

exfmt is in alpha. If you run into any problems, please report them.

Currently exfmt does not always produce semantically identical formatted Elixir. There are checks to prevent data loss, but please ensure you have backed up your code before running exfmt during this alpha stage.

The format produced by exfmt will change significantly before the 1.0.0 release. If this will cause problems for you, please refrain from using exfmt during the alpha- and beta-test periods.

exfmt formats Elixir source code according to a standard set of rules. It is inspired by Aaron VonderHaar's elm-format.

# exfmt takes any Elixir code...

defmodule MyApp, do: (
    use( SomeLib )
    def run( data ), do: {
      :ok,
      data
   }
)

# and rewrites it in a clean and idiomatic style:

defmodule MyApp do
  use SomeLib

  def run(data) do
    {:ok, data}
  end
end

The benefits of exfmt:

• It makes code easier to write, because you never have to worry about minor formatting concerns while powering out new code.
• It makes code easier to read, because there are no longer distracting minor stylistic differences between different code bases. As such, your brain can map more efficiently from source to mental model.
• It makes code easier to maintain, because you can no longer have diffs related only to formatting; every diff necessarily involves a material change.
• It saves your team time debating how to format things, because there is a standard tool that formats everything the same way.
• It saves you time because you don't have to nitpick over formatting details of your code.

Contents

• Usage
• Development

Usage

# Preview the exfmt formatting of an Elixir source file
mix exfmt path/to/file.ex

Development

exfmt is an open project, contributions are very much welcomed. If you have feedback or have found a bug, please open an issue. If you wish to make a code contribution please open a pull request, though for larger code changes it may be good to open an issue first so we can work out the best way to move forward.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

# Install the deps
mix deps.get

# Run the tests
mix test

# Run the tests when files change
mix test.watch

# Run the type checker
mix dialyzer