eslint-plugin-formatjs

What is eslint-plugin-formatjs?

eslint-plugin-formatjs is an ESLint plugin that provides linting rules for the FormatJS library, which is used for internationalization (i18n) in JavaScript applications. The plugin helps ensure that your usage of FormatJS is consistent and follows best practices.

What are eslint-plugin-formatjs's main functionalities?

Enforce id attribute in messages

This rule ensures that all messages have an 'id' attribute, which is useful for consistency and maintainability in large projects.

module.exports = {
  'rules': {
    'formatjs/enforce-id': ['error', { 'idInterpolationPattern': '[sha512:contenthash:base64:6]' }]
  }
};

No multiple plurals

This rule prevents the use of multiple plural forms in a single message, which can lead to confusion and errors in translations.

module.exports = {
  'rules': {
    'formatjs/no-multiple-plurals': 'error'
  }
};

No id in define messages

This rule disallows the use of 'id' attributes in defineMessages, promoting the use of defaultMessage instead.

module.exports = {
  'rules': {
    'formatjs/no-id-in-define-messages': 'error'
  }
};

Other packages similar to eslint-plugin-formatjs

eslint-plugin-i18n

eslint-plugin-i18n is another ESLint plugin that provides rules for internationalization. It focuses on ensuring that i18n best practices are followed, such as checking for missing translations and enforcing consistent message formats. Compared to eslint-plugin-formatjs, it is more general and not specifically tied to FormatJS.

eslint-plugin-react-intl

eslint-plugin-react-intl is an ESLint plugin specifically for React applications using the react-intl library. It provides rules to enforce best practices and consistency in the use of react-intl. While eslint-plugin-formatjs can be used with any JavaScript project, eslint-plugin-react-intl is tailored for React projects.

README

eslint-plugin-formatjs

We've migrated the docs to https://formatjs.io/docs/tooling/linter.