@lee-donghyun/eslint-plugin-lingui v2.2.0

@lee-donghyun/lingui/no-unlocalized-strings

Disallow raw strings (Literal or TemplateLiteral) that are not wrapped by a Lingui helper (t\`,msg``, or`). The rule targets React / TypeScript projects that use LinguiJS for i18n and encourages exhaustive localisation.

Installation

pnpm add -D @lee-donghyun/eslint-plugin-lingui

Configuration

Flat-config (ESLint ≥ 8.21)

// @ts-check

import { defineConfig } from "eslint-config-react-app-essentials";
import pluginLingui from "eslint-plugin-lingui";
import PluginLingui2 from "@lee-donghyun/eslint-plugin-lingui";

export default defineConfig({
  tsconfigRootDir: "./tsconfig.json",
  scope: ["src/**/*.{ts,tsx}"],
  extends: [
    pluginLingui.configs["flat/recommended"],
    PluginLingui2.configs.recommended,
    {
      rules: {
        "@lee-donghyun/lingui/no-unlocalized-strings": [
          "error",
          {
            ignoreAttributes: ["className", "src", "data-testid"],
            ignore: ["^[a-zA-Z0-9\\s\\p{P}\\p{S}]*$"],
          },
        ],
      },
    },
  ],
});

Rule details

Problems reported

The rule is not autofixable – localisation usually needs developer input.

Correct examples

import { t, msg } from "@lingui/macro";
import { Trans } from "@lingui/react";

<button aria-label={t`Close`}>
  <Trans>Close</Trans>
</button>;

const TITLE = t`Dashboard`; // tagged template
const error = msg`Error: ${statusCode}`; // tagged template

const HTTP_OK = "200" as const; // allowed (as const)

Incorrect examples

console.log("Untranslated log"); // Literal

<button aria-label="닫기">닫기</button>; // attribute + JSXText
<input placeholder={`Search ${name}`} />; // TemplateLiteral

Options

Example:

{
  "@lee-donghyun/lingui/no-unlocalized-strings": [
    "error",
    {
      "ignoreAttributes": ["^aria-", "data-testid$"],
      "ignore": ["^[0-9]+$", "^\\s*$"] // numbers or whitespace-only
    }
  ]
}