# 🇺🇸🇺🇸🇺🇸 Freedom Formatter 🇺🇸🇺🇸🇺🇸
A fork of Elixir's code formatter, with added freedom.
[](https://travis-ci.org/gamache/freedom_formatter) [](https://hex.pm/packages/freedom_formatter)
Freedom Formatter is a formatter plugin for Elixir files (`.ex` and `.exs`).
It supports all features of the standard code formatter (forked from Elixir 1.13.4),
as well as additional features unlikely to arrive soon in core Elixir.
<img src="https://gamache.github.io/images/freedom-formatter.jpg"
alt="Freedom Formatter">
## Usage
Install by adding the package to your `mix.exs`
```elixir
{:freedom_formatter, ">= 2.0.0", only: :dev}
```
Specify this package as a plugin for the formatter in `.formatter.exs`:
```elixir
# .formatter.exs
[
inputs: [
# ...
],
plugins: [
# ...
# Add this:
FreedomFormatter,
],
# Additional options are now supported:
trailing_comma: true,
]
```
## Why
Elixir's code formatter does not intend to support trailing commas,
or indeed any additional settings.
See Elixir issues [#7689](https://github.com/elixir-lang/elixir/pull/7689)
and [#6646](https://github.com/elixir-lang/elixir/issues/6646) for more
information.
Thanks to software freedom, we can use tomorrow's formatter today.
## Project Goals
* To provide a compatible alternative to the Elixir formatter,
available separately from the core Elixir distribution
* To allow developers and teams to benefit from standardized code
formatting while retaining a style they find more productive
* To be a testbed for new formatting features and options,
maintaining the easiest possible path to possible inclusion in
core Elixir.
## Added Features
Freedom Formatter supports all Elixir's standard code formatting
options, as well as:
* `:trailing_comma` - if set `true`, multi-line list, map, and
struct literals will include a trailing comma after the last item
or pair in the data structure. Does not affect argument lists,
tuples, or lists/maps/structs rendered on a single line.
* `:single_clause_on_do` - if set to `true`, will format `case` with single pattern with the pattern inline, like:
```elixir
# single_clause_on_do: false
case expr do
pattern -> body
end
# single_clause_on_do: true
case expr do pattern ->
body
end
```
## Authorship and License
Freedom Formatter is released under the same license as Elixir itself,
the Apache License Version 2.0, included here as the file `LICENSE`.
Freedom Formatter is based upon the Elixir code formatter, whose
implementation and tests are included in this project.
The core Elixir formatter was written by José Valim, with
contributions from Andrea Leopardi and others.
Authored by Pete Gamache.
Maintance by Marc-André Lafortune.
### Notes
* This project uses semantic versioning.
* This project gets a new branch for each new minor version of elixir (unless no change was made to the formatter).
* Each new branch has its history completely rewritten.
### Changelog
v2.0.0: Now a formatter plugin; as such it requires Elixir 1.13.2+
