mix erlfmt (mix_erlfmt v0.2.0)
Runs the erlfmt
command for the given project.
command-line-options
Command line options
-v, --version
- returns the version of erlfmt being used-w, --write
- modify formatted files in place-o, --out
- output directory--verbose
- include debug output-c, --check
- check if your files are formatted. Get exit code1
, if some files are not formatted.--write
is not supported.--print-width
- the line length that formatter would wrap on--require-pragma
- require a special comment@format
, called a pragma, to be present in the file's first docblock comment in order for prettier to format it.-i, --insert-pragma
- Insert a@format
pragma to the top of formatted files when pragma is absent. Works well when used in tandem with--require-pragma
, but it is not allowed to userequire-pragma
andinsert-pragma
at the same time.--exclude-files
- files not to format. This overrides the files specified to format<files>
- files to format,-
for stdin. If no files are provided, and one option of [-w
,-o
,-c
] are provided, then{src,include,test}/*.{hrl,erl,app.src}
and rebar.config are specified as the default.
configuration
Configuration
You can configure common options inside erlfmt
section in you Mix
project.
It's structure is the same as for rebar.config
and can be got from erlfmt
docs.
example
Example
defmodule MyApp.MixProject do
use Mix.Project
def project do
[
app: :my_app,
version: "0.0.1",
erlfmt: [print_width: 100]
]
end
end