eslint-plugin-react-google-translate weekly downloads statistics

eslint-plugin-react-google-translate

ESLint plugin to highlight code patterns in React applications which can lead to browser exceptions while the Google Translate browser extension is in use. This is a common problem for React applications and a known issue to both React and Google.

When active on a page, the Google Translate browser extension is very liberal with its DOM manipulation, notably, replacing text nodes with font tags. This can be a problem for React applications as it can cause exceptions to be thrown when _conditionally_ rendering text nodes with siblings within JSX expressions.

Whilst many proposals have been suggested to avoid browser issues, this ESLint plugin aims to solve the problem far earlier in the development process by highlighting certain code patterns to the developer which can cause a browser exception to be thrown where Google Translate is in use.

Examples of code that can throw:

The safe way to write this code, avoiding browser exceptions, is to wrap each of the conditionally rendered text nodes (with siblings) in an element (for example, a ). Static text nodes with preceding conditionally rendered siblings must also be wrapped:

An additional problem identified is React components returning text nodes directly (or numerical values which will be rendered as text). When a React component returns values other than JSX / null, Google Translate can continue to display stale values after state changes, without any error being thrown. Since this is very hard to debug it is better to avoid it altogether.

Installation

Usage (ESLint 9+, flat config)

Use the recommended config to enable all rules:

Or configure the rules individually (Each rule can be treated as a warning if an error is deemed too strict.):

Usage (ESLint 8, legacy .eslintrc)

The plugin still works with older ESLint versions using the legacy config format. Add react-google-translate to the plugins section of your .eslintrc configuration file:

TypeScript

The plugin supports TypeScript and will use type information where available. Type-aware checks run _in addition_ to the standard pattern-based checks.

Where type information is unavailable (e.g. in JavaScript files or in Node versions earlier than 18.18), the plugin falls back to pattern matching only. This reduces coverage slightly, but the plugin will still catch most problematic patterns without types.

Description from the npm listing.