@nkzw/eslint-plugin-fbtee 1.3.0 → 1.3.2

package/README.md

@@ -605,7 +605,7 @@ const Root = () => {
 
 ## ESLint Plugin
 
-You can install the optional eslint plugin to catch common mistakes and enforce best practices when using **fbtee**:
+You can install the optional ESLint plugin to catch common mistakes and enforce best practices when using **fbtee**:
 
 ```bash
 npm install -D @nkzw/eslint-plugin-fbtee
@@ -614,32 +614,56 @@ npm install -D @nkzw/eslint-plugin-fbtee
 Add the following configuration to your ESLint configuration:
 
 ```js
-{
-  extends: ['plugin:@nkzw/eslint-plugin-fbtee/recommended'],
-  plugins: ['@nkzw/eslint-plugin-fbtee'],
-}
+import fbtee from '@nkzw/eslint-plugin-fbtee';
+
+export default [
+  fbtee.configs.recommended,
+  {
+    plugins: {
+      '@nkzw/fbtee': fbtee,
+    },
+  },
+];
 ```
 
 If you want stricter enforcement of translation rules, you can use the strict configuration, which enables the `no-untranslated-strings` rule. This ensures that all strings in your codebase are marked for translation.
 
 ```js
-{
-  extends: ['plugin:@nkzw/eslint-plugin-fbtee/strict'],
-  plugins: ['@nkzw/eslint-plugin-fbtee'],
-}
+import fbtee from '@nkzw/eslint-plugin-fbtee';
+
+export default [
+  fbtee.configs.strict,
+  {
+    plugins: {
+      '@nkzw/fbtee': fbtee,
+    },
+  },
+];
 ```
 
 Alternatively, if you'd like more granular control over the rules:
 
 ```js
-{
-  plugins: ['@nkzw/eslint-plugin-fbtee'],
-  rules: {
-    '@nkzw/fbtee/no-empty-strings': 'error',
-    '@nkzw/fbtee/no-unhelpful-desc': 'error',
-    '@nkzw/fbtee/no-untranslated-strings': 'error',
+import fbtee from '@nkzw/eslint-plugin-fbtee';
+
+export default [
+  fbtee,
+  {
+    plugins: {
+      '@nkzw/fbtee': fbtee,
+    },
+    rules: {
+      '@nkzw/fbtee/no-empty-strings': [
+        'error',
+        {
+          ignoredWords: ['Banana', 'pnpm install fbtee'],
+        },
+      ],
+      '@nkzw/fbtee/no-unhelpful-desc': 'error',
+      '@nkzw/fbtee/no-untranslated-strings': 'error',
+    },
   },
-}
+];
 ```
 
 ## What's better about `fbtee` than `fbt`?

package/lib/index.cjs

@@ -25,7 +25,7 @@ const __typescript_eslint_utils = __toESM(require("@typescript-eslint/utils"));
 
 //#region package.json
 var name = "@nkzw/eslint-plugin-fbtee";
-var version = "1.3.0";
+var version = "1.3.2";
 var description = "";
 var keywords = [];
 var repository = {
@@ -41,8 +41,8 @@ var exports$1 = {
 };
 var main = "lib/index.cjs";
 var scripts = { "build": "tsdown src/index.tsx -d lib --target=node22 --format=esm,cjs --clean --dts" };
-var dependencies = { "@typescript-eslint/utils": "^8.36.0" };
-var devDependencies = { "@typescript-eslint/rule-tester": "^8.36.0" };
+var dependencies = { "@typescript-eslint/utils": "^8.38.0" };
+var devDependencies = { "@typescript-eslint/rule-tester": "^8.38.0" };
 var package_default = {
 	name,
 	version,
@@ -284,12 +284,15 @@ const attributes = new Set([
 	"aria-label",
 	"aria-errormessage"
 ]);
+const shouldIgnoreParent = (node) => {
+	const { parent } = node;
+	const openingElement = parent?.type === "JSXElement" ? parent?.openingElement : null;
+	return openingElement?.type === "JSXOpeningElement" && openingElement.name.type === "JSXIdentifier" && (openingElement.name.name === "pre" || openingElement.name.name === "code");
+};
 var no_untranslated_strings_default = createRule({
 	create(context, options) {
-		const ignoredWords = new Set(options[0].ignoredWords.map((s) => s.trim().toLowerCase()));
-		function isIgnoredWord(value) {
-			return ignoredWords.has(value.trim().toLowerCase());
-		}
+		const ignoredWords = new Set(options[0].ignoredWords.map((value) => value.trim().toLowerCase()));
+		const isIgnoredWord = (value) => ignoredWords.has(value.replaceAll(/\s+/g, " ").toLowerCase());
 		return {
 			JSXAttribute(node) {
 				const propName = getPropName(node);
@@ -308,6 +311,7 @@ var no_untranslated_strings_default = createRule({
 				const value = resolveNodeValue(node.expression);
 				if (!value) return;
 				if (isIgnoredWord(value)) return;
+				if (shouldIgnoreParent(node)) return;
 				if (!hasFbtParent(node)) context.report({
 					messageId: "unwrappedString",
 					node
@@ -317,6 +321,7 @@ var no_untranslated_strings_default = createRule({
 				const value = node.value.trim();
 				if (!value) return;
 				if (isIgnoredWord(value)) return;
+				if (shouldIgnoreParent(node)) return;
 				if (!hasFbtParent(node)) {
 					const startOffset = node.range[0] + node.value.indexOf(value);
 					const endOffset = startOffset + value.length;

package/lib/index.js

@@ -2,7 +2,7 @@ import { ESLintUtils } from "@typescript-eslint/utils";
 
 //#region package.json
 var name = "@nkzw/eslint-plugin-fbtee";
-var version = "1.3.0";
+var version = "1.3.2";
 var description = "";
 var keywords = [];
 var repository = {
@@ -18,8 +18,8 @@ var exports = {
 };
 var main = "lib/index.cjs";
 var scripts = { "build": "tsdown src/index.tsx -d lib --target=node22 --format=esm,cjs --clean --dts" };
-var dependencies = { "@typescript-eslint/utils": "^8.36.0" };
-var devDependencies = { "@typescript-eslint/rule-tester": "^8.36.0" };
+var dependencies = { "@typescript-eslint/utils": "^8.38.0" };
+var devDependencies = { "@typescript-eslint/rule-tester": "^8.38.0" };
 var package_default = {
 	name,
 	version,
@@ -261,12 +261,15 @@ const attributes = new Set([
 	"aria-label",
 	"aria-errormessage"
 ]);
+const shouldIgnoreParent = (node) => {
+	const { parent } = node;
+	const openingElement = parent?.type === "JSXElement" ? parent?.openingElement : null;
+	return openingElement?.type === "JSXOpeningElement" && openingElement.name.type === "JSXIdentifier" && (openingElement.name.name === "pre" || openingElement.name.name === "code");
+};
 var no_untranslated_strings_default = createRule({
 	create(context, options) {
-		const ignoredWords = new Set(options[0].ignoredWords.map((s) => s.trim().toLowerCase()));
-		function isIgnoredWord(value) {
-			return ignoredWords.has(value.trim().toLowerCase());
-		}
+		const ignoredWords = new Set(options[0].ignoredWords.map((value) => value.trim().toLowerCase()));
+		const isIgnoredWord = (value) => ignoredWords.has(value.replaceAll(/\s+/g, " ").toLowerCase());
 		return {
 			JSXAttribute(node) {
 				const propName = getPropName(node);
@@ -285,6 +288,7 @@ var no_untranslated_strings_default = createRule({
 				const value = resolveNodeValue(node.expression);
 				if (!value) return;
 				if (isIgnoredWord(value)) return;
+				if (shouldIgnoreParent(node)) return;
 				if (!hasFbtParent(node)) context.report({
 					messageId: "unwrappedString",
 					node
@@ -294,6 +298,7 @@ var no_untranslated_strings_default = createRule({
 				const value = node.value.trim();
 				if (!value) return;
 				if (isIgnoredWord(value)) return;
+				if (shouldIgnoreParent(node)) return;
 				if (!hasFbtParent(node)) {
 					const startOffset = node.range[0] + node.value.indexOf(value);
 					const endOffset = startOffset + value.length;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nkzw/eslint-plugin-fbtee",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "",
   "keywords": [],
   "repository": {
@@ -16,10 +16,10 @@
   },
   "main": "lib/index.cjs",
   "dependencies": {
-    "@typescript-eslint/utils": "^8.36.0"
+    "@typescript-eslint/utils": "^8.38.0"
   },
   "devDependencies": {
-    "@typescript-eslint/rule-tester": "^8.36.0"
+    "@typescript-eslint/rule-tester": "^8.38.0"
   },
   "scripts": {
     "build": "tsdown src/index.tsx -d lib --target=node22 --format=esm,cjs --clean --dts"

package/src/__tests__/no-untranslated-strings-test.tsx

@@ -225,6 +225,28 @@ ruleTester.run('no-untranslated-strings', rule, {
         },
       ],
     },
+    {
+      code: `
+        <div>
+          <p>GitHub is cool</p>
+          <p>{\`GitHub
+ is cool\`}</p>
+          <p>
+            GitHub
+            is
+            cool
+          </p>
+          <p>
+            GitHub  is  cool
+          </p>
+        </div>
+       `,
+      options: [
+        {
+          ignoredWords: ['GitHub is cool'],
+        },
+      ],
+    },
     {
       code: `
         <textarea rows={2}></textarea>
@@ -275,5 +297,19 @@ ruleTester.run('no-untranslated-strings', rule, {
        const foo = helloGreeting || 'goodbye'
        `,
     },
+    {
+      code: `
+        <code>
+          console.log('Banana Banana Banana');
+        </code>
+       `,
+    },
+    {
+      code: `
+        <pre>{\`
+          console.log('Banana Banana Banana');
+        \`}</pre>
+       `,
+    },
   ],
 });

package/src/rules/no-untranslated-strings.tsx

@@ -1,3 +1,4 @@
+import { TSESTree } from '@typescript-eslint/utils';
 import {
   createRule,
   getPropName,
@@ -17,15 +18,25 @@ const attributes = new Set([
   'aria-errormessage',
 ]);
 
+const shouldIgnoreParent = (node: TSESTree.Node) => {
+  const { parent } = node;
+  const openingElement =
+    parent?.type === 'JSXElement' ? parent?.openingElement : null;
+  return (
+    openingElement?.type === 'JSXOpeningElement' &&
+    openingElement.name.type === 'JSXIdentifier' &&
+    (openingElement.name.name === 'pre' || openingElement.name.name === 'code')
+  );
+};
+
 export default createRule<Options, 'unwrappedString'>({
   create(context, options) {
     const ignoredWords = new Set(
-      options[0].ignoredWords.map((s) => s.trim().toLowerCase()),
+      options[0].ignoredWords.map((value) => value.trim().toLowerCase()),
     );
 
-    function isIgnoredWord(value: string) {
-      return ignoredWords.has(value.trim().toLowerCase());
-    }
+    const isIgnoredWord = (value: string) =>
+      ignoredWords.has(value.replaceAll(/\s+/g, ' ').toLowerCase());
 
     return {
       JSXAttribute(node) {
@@ -73,6 +84,10 @@ export default createRule<Options, 'unwrappedString'>({
           return;
         }
 
+        if (shouldIgnoreParent(node)) {
+          return;
+        }
+
         if (!hasFbtParent(node)) {
           context.report({
             messageId: 'unwrappedString',
@@ -92,6 +107,10 @@ export default createRule<Options, 'unwrappedString'>({
           return;
         }
 
+        if (shouldIgnoreParent(node)) {
+          return;
+        }
+
         if (!hasFbtParent(node)) {
           const startOffset = node.range[0] + node.value.indexOf(value);
           const endOffset = startOffset + value.length;