リファレンス

CLI

terminalやCIからHTML+ERB fileをformat、check、lintします。

使い方

erbfmt [OPTIONS] [FILE]...
erbfmt init [--force]

format、check、lintには1つ以上のfile pathが必要です。現在は標準入力に対応していません。単一fileはすべてのmodeを利用でき、複数fileには --write、--check、--lintのいずれかが必要です。

shellのglob展開で複数pathを渡せます。

erbfmt --write app/views/**/*.html.erb

erbfmt FILE標準出力 · 単一file: 1つのfileをformatし、source fileを変更せず結果を標準出力へ表示します。
--write1つ以上のfile: 各fileをformatして上書きします。成功するとfileごとに確認messageを表示します。
--check1つ以上のfile: fileを書き換えず、formatによる変更が必要か確認します。未formatのfileが1つでもあると失敗します。
--lint1つ以上のfile: formatせずlint diagnosticsを実行します。errorがある場合は失敗し、warningだけの場合は成功します。

--write、--check、--lintは同時に指定できません。

--config PATH: 指定した erbfmt.jsonを使います。指定しない場合はcurrent directoryから親directoryへ向かって検索し、見つからなければbuilt-in defaultを使います。
-h, --help: command helpを表示して終了します。
-V, --version: installされているerbfmtのversionを表示して終了します。

formatterとlinterの全項目は設定リファレンスを参照してください。

current directoryにdefaultの erbfmt.jsonを作成します。

erbfmt init

既存fileは自動的に置き換えません。明示的に上書きする場合は次を実行します。

erbfmt init --force

0成功: formatまたはwriteが完了した、すべてのcheck対象がformat済みだった、またはlintでerrorが見つからなかった場合です。
1処理失敗: 未formatのfile、lint error、file path不足、file/configの読み込みやparse失敗などが発生した場合です。
2不正なCLI指定: 無効なoptionを指定した、または同時に使えないmode flagを組み合わせた場合です。

erbfmt --check app/views/**/*.html.erb
erbfmt --lint app/views/**/*.html.erb