id-prefix.md

Enforce react-intl message ids to use predefined prefixes (id-prefix)

This rule checks ids used in react-intl's <FormattedMessage />, formatMessage and defineMessages, to determine if they (or template literal pattern) begin with one of predefined prefixes.

Prefixes are defined in eslint settings.

Rule Details

Given valid prefixes as in_ and out_...

Examples of incorrect code for this rule:

<FormattedMessage id='missing_example' />

formatMessage({ id:'missing_example' })

defineMessages({ msg: { id: 'missing_example' }})

defineMessage({ id:'missing_example' })

Examples of correct code for this rule:

<FormattedMessage id='in_example' />

<FormattedMessage id={ `in_${someKey}_label` } />

<FormattedMessage id='out_example' />

formatMessage({ id: 'in_example' })

formatMessage({ id: `in_${someKey}_label` })

formatMessage({ id: 'out_example' })

defineMessages({ msg: { id: 'in_example' }})

defineMessages({ msg: { id: `in_${someKey}_label` }})

defineMessages({ msg: { id: 'out_example' }})

defineMessage({ id: 'in_example' })

defineMessage({ id: `in_${someKey}_label` })

defineMessage({ id: 'out_example' })

Options

"@godaddy/react-intl/id-prefix": [<enabled>, Array<string>]

Where the array should contain allowed id prefixes.