@rpcbase/eslint-config 0.17.0 → 0.18.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rpcbase/eslint-config",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "description": "",
   "license": "MIT",
   "type": "module",
@@ -33,6 +33,7 @@
   },
   "dependencies": {
     "@eslint/js": "9.26.0",
+    "@typescript-eslint/experimental-utils": "5.62.0",
     "eslint-config-flat-gitignore": "2.1.0",
     "eslint-import-resolver-typescript": "4.3.4",
     "eslint-plugin-import": "2.31.0",
@@ -43,7 +44,7 @@
   },
   "devDependencies": {
     "@types/eslint": "9.6.1",
-    "typescript": "^5.x",
-    "eslint": "^9.x"
+    "eslint": "^9.x",
+    "typescript": "^5.x"
   }
 }

package/src/rules/no-lone-text-node.ts

@@ -0,0 +1,72 @@
+import { TSESTree, ESLintUtils } from "@typescript-eslint/experimental-utils"
+
+type MessageIds = "loneText"
+
+const createRule = ESLintUtils.RuleCreator(
+  name => `@rpcbase/eslint-config/rules/${name}`
+)
+
+export const rules = {
+  "no-lone-text-node": createRule<[], MessageIds>({
+    name: "no-lone-text-node",
+    meta: {
+      type: "problem",
+      docs: {
+        description: "disallow raw text nodes in JSX",
+        recommended: "error"
+      },
+      messages: {
+        loneText: "Wrap text '{{text}}' in an element (e.g. <span>) to avoid Google Translate crashes."
+      },
+      schema: []
+    },
+    defaultOptions: [],
+    create(context) {
+      //----------------------------------------------------------------------
+      // helpers
+      //----------------------------------------------------------------------
+
+      function isAllowedWrapper(node: TSESTree.JSXElement) {
+        const name = node.openingElement.name
+        return (
+          name.type === "JSXIdentifier" &&
+          ["span", "p", "label", "div", "strong", "em", "Trans", "button"].includes(
+            name.name
+          )
+        )
+      }
+
+      function report(node: TSESTree.Node, value: string) {
+        context.report({ node, messageId: "loneText", data: { text: value } })
+      }
+
+      //----------------------------------------------------------------------
+      // visitors
+      //----------------------------------------------------------------------
+
+      return {
+        JSXElement(node) {
+          if (isAllowedWrapper(node)) return
+
+          node.children.forEach(child => {
+            if (
+              child.type === "JSXText" &&
+              child.value.trim().length > 0
+            ) {
+              report(child, child.value.trim())
+            }
+
+            if (
+              child.type === "JSXExpressionContainer" &&
+              child.expression.type === "Literal" &&
+              typeof child.expression.value === "string" &&
+              child.expression.value.trim().length > 0
+            ) {
+              report(child, child.expression.value.trim())
+            }
+          })
+        }
+      }
+    }
+  })
+}