Brandlint Docs

Supported Files

File types and strings that Brandlint analyzes.

Brandlint extracts user-facing strings from your code automatically. The file types below are tested, but extraction often works with other formats too. If you notice strings not being captured correctly, let us know.

Tested file types

CategoryExtensions
JavaScript/TypeScript.ts, .tsx, .js, .jsx, .mjs, .cjs
Frontend frameworks.vue, .svelte
Markup.html, .htm
Templates.ejs, .hbs, .handlebars, .mustache, .pug, .jade
PHP.php, .blade.php, .twig
Ruby.erb, .slim, .haml
Python.py
.NET.cshtml, .razor
Data/Config.json, .yaml, .yml
Content.md, .mdx

What gets extracted

Brandlint looks for common UI patterns:

  • Text between tags: <Button>Submit</Button>
  • UI properties: label, placeholder, title, message, error, description, tooltip, aria-label, alt
  • i18n keys: t("welcome_message")
  • Link/button text

What's ignored

  • Import statements
  • Comments
  • Variable names and identifiers
  • URLs and file paths
  • Template expressions
  • Strings shorter than 2 characters

Excluding files

Add patterns to brandlint.yml:

ignore:
  - "src/generated/**"
  - "**/*.test.tsx"

See ignore patterns for more examples.