feat(no-unlocalized-strings): remove default configuration

lingui · Nov 4, 2024 · f70111e · f70111e
1 parent e249254
commit f70111e
Show file tree

Hide file tree

Showing 5 changed files with 260 additions and 329 deletions.
diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ yarn add eslint-plugin-lingui --dev
 
 ### Recommended Setup
 
-To enable all of the recommended rules for our plugin, add the following config:
+To enable all the recommended rules for our plugin, add the following config:
 
 ```js
 import pluginLingui from 'eslint-plugin-lingui'
@@ -47,6 +47,8 @@ export default [
 ]
 ```
 
+We also recommend enabling the [no-unlocalized-strings](docs/rules/no-unlocalized-strings.md) rule. It’s not enabled by default because it needs to be set up specifically for your project. Please check the rule's documentation for example configurations.
+
 ### Custom setup
 
 Alternatively, you can load the plugin and configure only the rules you want to use:

diff --git a/docs/rules/no-unlocalized-strings.md b/docs/rules/no-unlocalized-strings.md
@@ -5,18 +5,93 @@ Ensures that all string literals, templates, and JSX text are wrapped using `<Tr
 > [!IMPORTANT]  
 > This rule may require TypeScript type information. Enable this feature by setting `{ useTsTypes: true }`.
 
+This rule is designed to **match all** JSXText, StringLiterals, and TmplLiterals, and then exclude some of them based on attributes, property names, variable names, and so on.
+
+The rule doesn’t come with built-in ignore settings because each project is unique and needs different configurations. You can use the following config as a starting point and then adjust it for your project:
+
+<!-- prettier-ignore -->
+```json5
+{
+  "no-unlocalized-strings": [
+    "error",
+    {
+      "useTsTypes": true,
+      "ignore": [
+        // Ignore strings that do not contain words
+        "^[^A-Za-z]+$",
+        // Ignore strings that don’t start with an uppercase letter
+        //   or don't contain two words separated by whitespace
+        "^(?![A-Z].*|\\w+\\s\\w+).+$",
+        // Ignore UPPERCASE literals
+        // Example: const test = "FOO"
+        "^[A-Z_-]+$"
+      ],
+      "ignoreAttribute": [
+        // Ignore attributes matching className (case-insensitive)
+        { "regex": { "pattern": "className", "flags": "i" } },
+        "styleName",
+        "src",
+        "srcSet",
+        "type",
+        "id",
+        "width",
+        "height"
+      ],
+      "ignoreProperty": [
+        // Ignore properties matching className (case-insensitive)
+        { "regex": { "pattern": "className", "flags": "i" } },
+        "styleName",
+        "type",
+        "id",
+        "width",
+        "height",
+        "displayName",
+        "Authorization",
+        // Ignore UPPERCASE properties
+        // Example: test.FOO = "ola!"
+        { "regex": { "pattern": "^[A-Z_-]+$" } }
+      ],
+      "ignoreFunction": [
+        "cva",
+        "cn",
+        "track",
+        "Error",
+        "console.*",
+        "*headers.set",
+        "*.addEventListener",
+        "*.removeEventListener",
+        "*.postMessage",
+        "*.getElementById",
+        "*.dispatch",
+        "*.commit",
+        "*.includes",
+        "*.indexOf",
+        "*.endsWith",
+        "*.startsWith",
+        "require"
+      ],
+      "ignoreVariable": [
+        // Ignore literals assigned to variables with UPPERCASE names
+        // Example: const FOO = "Ola!"
+        { "regex": { "pattern": "^[A-Z_-]+$" } }
+      ],
+      "ignoreMethodsOnType": [
+        // Ignore specified methods on Map and Set types
+        "Map.get",
+        "Map.has",
+        "Set.has"
+      ]
+    }
+  ]
+}
+```
+
 ## Options
 
 ### `useTsTypes`
 
 Enables the rule to use TypeScript type information. Requires [typed linting](https://typescript-eslint.io/getting-started/typed-linting/) to be configured.
 
-This option automatically excludes built-in methods such as `Map` and `Set`, and cases where string literals are used as TypeScript constants, e.g.:
-
-```ts
-const a: 'abc' = 'abc'
-```
-
 ### `ignore`
 
 Specifies patterns for string literals to ignore. Strings matching any of the provided regular expressions will not trigger the rule.
@@ -77,7 +152,7 @@ foo[getName()].set('Hello')
 
 ### `ignoreAttribute`
 
-Specifies JSX attributes that should be ignored. By default, the attributes `className`, `styleName`, `type`, `id`, `width`, and `height` are ignored.
+Specifies JSX attributes that should be ignored.
 
 Example for `{ "ignoreAttribute": ["style"] }`:
 
@@ -158,16 +233,16 @@ const element = <div description="IMAGE" />
 
 ### `ignoreProperty`
 
-Specifies object property names whose values should be ignored. By default, UPPERCASED properties and `className`, `styleName`, `type`, `id`, `width`, `height`, and `displayName` are ignored.
+Specifies object property names whose values should be ignored.
 
-Example for `{ "ignoreProperty": ["myProperty"] }`:
+Example for `{ "ignoreProperty": ["displayName"] }`:
 
 ```jsx
-const obj = { myProperty: 'Ignored value' }
-obj.myProperty = 'Ignored value'
+const obj = { displayName: 'Ignored value' }
+obj.displayName = 'Ignored value'
 
 class MyClass {
-  myProperty = 'Ignored value'
+  displayName = 'Ignored value'
 }
 ```
 
@@ -208,7 +283,7 @@ class MyClass {
 
 ### `ignoreVariable`
 
-Specifies variable name whose values should be ignored. By default, UPPERCASED variables are ignored.
+Specifies variable name whose values should be ignored.
 
 Example for `{ "ignoreVariable": ["myVariable"] }`:
 
@@ -264,5 +339,3 @@ interface Foo {
 const foo: Foo
 foo.get('Some string')
 ```
-
-The following methods are ignored by default: `Map.get`, `Map.has`, `Set.has`.
diff --git a/src/helpers.ts b/src/helpers.ts
@@ -29,8 +29,6 @@ export const LinguiCallExpressionMessageQuery =
  */
 export const LinguiTransQuery = 'JSXElement[openingElement.name.name=Trans]'
 
-export const UpperCaseRegexp = /^[A-Z_-]+$/
-
 export function isNativeDOMTag(str: string) {
   return DOM_TAGS.includes(str)
 }
@@ -39,27 +37,13 @@ export function isSvgTag(str: string) {
   return SVG_TAGS.includes(str)
 }
 
-export function containAllAttributes(attributeNames: string[]) {
-  const attrs = ['value', 'other']
-  return attrs.every((attr) => attributeNames.includes(attr))
-}
-
-export function isLinguiTags(str: string, attributeNames: string[]) {
-  if (str === 'Trans') {
-    return true
-  }
-  return ['Plural', 'Select'].includes(str) && containAllAttributes(attributeNames)
-}
-
 const blacklistAttrs = ['placeholder', 'alt', 'aria-label', 'value']
 export function isAllowedDOMAttr(tag: string, attr: string, attributeNames: string[]) {
   if (isSvgTag(tag)) return true
   if (isNativeDOMTag(tag)) {
     return !blacklistAttrs.includes(attr)
   }
-  if (isLinguiTags(tag, attributeNames)) {
-    return true
-  }
+
   return false
 }
 
@@ -87,26 +71,6 @@ export const getText = (
   return node.value.toString().trim()
 }
 
-export function hasAncestorWithName(
-  node: TSESTree.JSXElement | TSESTree.TemplateLiteral | TSESTree.Literal | TSESTree.JSXText,
-  name: string,
-) {
-  let p: TSESTree.Node = node.parent
-  while (p) {
-    switch (p.type) {
-      case TSESTree.AST_NODE_TYPES.JSXElement:
-        const identifierName = getIdentifierName(p?.openingElement?.name)
-        if (identifierName === name) {
-          return true
-        }
-      default:
-    }
-
-    p = p.parent
-  }
-  return false
-}
-
 export function getIdentifierName(jsxTagNameExpression: TSESTree.JSXTagNameExpression) {
   switch (jsxTagNameExpression.type) {
     case TSESTree.AST_NODE_TYPES.JSXIdentifier: