Module steamroller

Steamroller

.

Description

Steamroller

Steamroller is an opinionated Erlang code formatter.

See the Github README for more info.

Use

Add steamroller to your rebar config:

  {plugins, [steamroller]}.

Then ask it to steamroll your code directly in an existing application:

  $ rebar3 steamroll
  ===> Fetching steamroller
  ===> Compiling steamroller
  <Steamroller Output>

CI

You can use steamroller to check that code is properly formatted as part of your CI:

  $ rebar3 steamroll --check

The exit code will be non-zero if the code has not been formatted before being committed.

Configure

See the Github README for the latest configuration options.

Function Index

format_file/1Format a file.
format_file/2Format a file with options.
init/1Initialises the rebar3 plugin.

Function Details

format_file/1

format_file(File::binary()) -> ok | {error, any()}

Format a file.

format_file/2

format_file(File::binary(), Opts::[any()]) -> ok | {error, any()}

Format a file with options.

init/1

init(State::rebar_state:t()) -> {ok, rebar_state:t()}

Initialises the rebar3 plugin.


Generated by EDoc