Bylaw.Credo.Check.HEEx.RequireAccessibleButtonText (bylaw_credo v0.1.0-alpha.1)

Basics

This check has a base priority of high and works with any version of Elixir.

Explanation

Requires static HEEx/HTML button tags to have an accessible name.

Examples

Embedded ~H templates are checked during normal Credo runs over Elixir files. Standalone .html.heex templates require enabling Bylaw.Credo.Plugin.HEExSources in Credo's plugins configuration. Avoid:

  ~H"""
  <button type="button"><.icon name="hero-x-mark" /></button>
  """

Prefer:

  ~H"""
  <button type="button">Close</button>
  <button type="button" aria-label="Close"><.icon name="hero-x-mark" /></button>
  <button type="button">{@label}</button>
  """

Notes

Embedded ~H templates in .ex and .exs files are checked by Credo's normal source traversal. Standalone .html.heex templates are checked when Bylaw.Credo.Plugin.HEExSources is enabled in .credo.exs.

This check uses static HEEx token analysis, so it reports only patterns visible in the template source.

Options

This check has no check-specific options. Configure it with an empty option list.

Usage

Add this check to Credo's checks: list in .credo.exs:

%{
  configs: [
    %{
      name: "default",
      checks: [
        {Bylaw.Credo.Check.HEEx.RequireAccessibleButtonText, []}
      ]
    }
  ]
}

Check-Specific Parameters

There are no specific parameters for this check.

General Parameters

Like with all checks, general params can be applied.

Parameters can be configured via the .credo.exs config file.