mix farol (Farol v0.2.0)

Copy Markdown View Source

Statically audits HEEx templates for accessibility issues.

mix farol                          # audit lib/**/*.heex
mix farol lib/my_app_web/live      # audit a specific path
mix farol --format sarif --output farol.sarif
mix farol --except phx-click-interactive

Exits with a non-zero status when any error-severity finding or parse error is found, so it drops straight into CI. --format sarif plus github/codeql-action/upload-sarif annotates pull requests; the farol GitHub Action wraps exactly that.

Requires phoenix_live_view (the HEEx parser lives there). It is an optional dependency of farol: add it to your project if it is not already a dependency.

Options

  • --format - terminal (default) or sarif
  • --output - write the report to a file instead of stdout
  • --except - comma-separated rule ids to skip
  • --only - run just these comma-separated rule ids