# `Volt.Formatter`
[🔗](https://github.com/elixir-volt/volt/blob/v0.10.1/lib/volt/formatter.ex#L1)

A `mix format` plugin that formats JavaScript and TypeScript files with oxfmt.

## Setup

Add `Volt.Formatter` to your `.formatter.exs`:

    [
      plugins: [Volt.Formatter],
      inputs: [
        "{mix,.formatter}.exs",
        "{config,lib,test}/**/*.{ex,exs}",
        "assets/**/*.{js,ts,jsx,tsx}"
      ]
    ]

## Configuration

Reads options from `config :volt, :format` or falls back to
`.oxfmtrc.json` / `.prettierrc.json`. See the "Formatter & linter configuration" section in the README for details.

---

*Consult [api-reference.md](api-reference.md) for complete listing*