🎉 Brail Beta has been released. Read more →
Brail
DocsDocsPlaygroundPlayground
GitHubGitHub (opens in a new tab)
  • Introduction
  • Quick start
  • What's included?
  • Why Brail?
  • FAQ
  • Crafting templates
    • HTML Email Primer
    • Email Templates
    • Components
    • Responsiveness
    • Theming
    • Devtools
    • Linting
    • Static Files
  • Using templates
    • Calling Directly
    • Creating a tRPC API
    • Creating a REST API
    • Security
  • Recipes
    • Sending Test Emails
    • Generating an OpenAPI client
    • Next JS Integration
  • Docs
    • Introduction
    • Quick start
    • What's included?
    • Why Brail?
    • FAQ
    • Crafting templates
      • HTML Email Primer
      • Email Templates
      • Components
      • Responsiveness
      • Theming
      • Devtools
      • Linting
      • Static Files
    • Using templates
      • Calling Directly
      • Creating a tRPC API
      • Creating a REST API
      • Security
    • Recipes
      • Sending Test Emails
      • Generating an OpenAPI client
      • Next JS Integration
  • Playground
Question? Give us feedback → (opens in a new tab)Edit this page
Docs
Crafting templates
Linting

Linting

Given email correctness lies on a spectrum, Brail offers an eslint plugin to ascertain just how much email client support your code might have. As well as arbitrary linting rules, the plugin uses up-to-date data on email client support, sourced from caniemail.com (opens in a new tab).

Full credit for the data and other email wisdom: HTeuMeuLeu (opens in a new tab).

To install the plugin:

pnpm add -D @brail/eslint-plugin

Add the following to your eslint configuration:

{
  // ...
  plugins: ["@brail"],
  extends: ["plugin:@brail/recommended"],
  // ...
}
DevtoolsStatic Files

Apache 2023 © Brail.