MUI Company Name Reference Check

This rule helps maintain consistency in documentation by discouraging direct references to "MUI" followed by words that aren't officially approved product or organizational terms. The motivation behind this rule is to ensure clear communication and branding by encouraging writers to reference specific products or teams rather than using the company name in potentially ambiguous or inconsistent ways.

Examples

Will Flag ⚠️:

  • "MUI developers are working on this"
  • "MUI engineers announced..."
  • "Contact MUI support"

Will NOT Flag ✅:

  • "MUI X is available now"
  • "Contact the MUI team"
  • "Part of the MUI ecosystem"
  • "Available in the MUI Store"
  • "MUI Core components"

The rule looks for instances of "MUI" followed by any word character(s), but makes specific exceptions for approved terms like "MUI X", "MUI System", "MUI Store", and organizational terms like "MUI team" or "MUI ecosystem". This helps maintain consistent branding and clear communication across documentation.

Rule Source

This rule comes from: https://github.com/mui/material-ui

Rule Definition

extends: existence
message: We avoid referencing the company name '%s'. Instead you can reference a product or the team.
level: warning
ignorecase: false
tokens:
  - 'MUI \w+'
exceptions:
  - 'MUI X'
  - 'MUI System'
  - 'MUI Store'
  - 'MUI Core'
  - 'MUI Connect'
  # valid use of a regular space
  - 'MUI organization'
  - 'MUI ecosystem'
  - 'MUI products'
  - 'MUI team'