@nkzw/eslint-plugin-fbtee 1.7.0 → 1.7.3

package/README.md

@@ -114,7 +114,8 @@ export default {
 By default, **fbtee** expects your source code to be anywhere within your project, your translations in a `translations` folder, and the generated translations in `src/translations`. You can customize these paths using command line arguments:
 
 - The `--translations` parameter can be specified to `fbtee translate` to customize the path to the input translation files.
-- `--output-dir` can be specified to define where the output translations should be written so they can be loaded in your app. You can also use `--out` parameter to output a single file such as `translations.json`, which can be used directly in your app without loading individual translation files.
+- The `--output-dir` parameter defines where the output translation files per language should be written (one file per locale), so they can be lazy loaded in your app.
+- The `--output-file` parameter outputs all translations in a single combined file, which can be used directly in your app without loading individual files.
 
 If you want to use different paths, it is recommended to define custom commands in your `package.json`:
 

package/lib/{index.d.ts → index.d.mts}

@@ -22,11 +22,17 @@ declare const _default: {
     version: string;
   };
   rules: {
-    'no-empty-strings': _typescript_eslint_utils_ts_eslint0.RuleModule<"emptyString" | "jsxEmptyString", [], unknown, _typescript_eslint_utils_ts_eslint0.RuleListener>;
-    'no-unhelpful-desc': _typescript_eslint_utils_ts_eslint0.RuleModule<"emptyDesc" | "jsxEmptyDesc" | "duplicateDesc" | "shortDesc", [], unknown, _typescript_eslint_utils_ts_eslint0.RuleListener>;
+    'no-empty-strings': _typescript_eslint_utils_ts_eslint0.RuleModule<"emptyString" | "jsxEmptyString", [], unknown, _typescript_eslint_utils_ts_eslint0.RuleListener> & {
+      name: string;
+    };
+    'no-unhelpful-desc': _typescript_eslint_utils_ts_eslint0.RuleModule<"emptyDesc" | "jsxEmptyDesc" | "duplicateDesc" | "shortDesc", [], unknown, _typescript_eslint_utils_ts_eslint0.RuleListener> & {
+      name: string;
+    };
     'no-untranslated-strings': _typescript_eslint_utils_ts_eslint0.RuleModule<"unwrappedString", [{
       ignoredWords: Array<string>;
-    }], unknown, _typescript_eslint_utils_ts_eslint0.RuleListener>;
+    }], unknown, _typescript_eslint_utils_ts_eslint0.RuleListener> & {
+      name: string;
+    };
   };
 };
 //#endregion

package/lib/{index.js → index.mjs}

@@ -1,57 +1,24 @@
 import { ESLintUtils } from "@typescript-eslint/utils";
-
 //#region package.json
 var name = "@nkzw/eslint-plugin-fbtee";
-var version = "1.7.0";
-var description = "";
-var keywords = [];
-var repository = {
-	"type": "git",
-	"url": "git+https://github.com/nkzw-tech/fbtee.git",
-	"directory": "packages/eslint-plugin-fbtee"
-};
-var license = "MIT";
-var type = "module";
-var exports = {
-	"import": "./lib/index.js",
-	"require": "./lib/index.cjs"
-};
-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.46.0" };
-var devDependencies = { "@typescript-eslint/rule-tester": "^8.46.0" };
-var package_default = {
-	name,
-	version,
-	description,
-	keywords,
-	repository,
-	license,
-	type,
-	exports,
-	main,
-	scripts,
-	dependencies,
-	devDependencies
-};
-
+var version = "1.7.3";
 //#endregion
 //#region src/utils.tsx
-const createRule = ESLintUtils.RuleCreator((name$1) => `https://github.com/nkzw-tech/fbtee/blob/main/packages/eslint-plugin-fbtee/docs/rules/${name$1}.md`);
+const createRule = ESLintUtils.RuleCreator((name) => `https://github.com/nkzw-tech/fbtee/blob/main/packages/eslint-plugin-fbtee/docs/rules/${name}.md`);
 function resolveMemberExpressions(object, property) {
 	if (object.type === "JSXMemberExpression") return `${resolveMemberExpressions(object.object, object.property)}.${property.name}`;
 	return `${object.name}.${property.name}`;
 }
 function elementType(node) {
 	if (node.type === "JSXFragment") return "<>";
-	const { name: name$1 } = node.openingElement;
-	switch (name$1.type) {
-		case "JSXIdentifier": return name$1.name;
+	const { name } = node.openingElement;
+	switch (name.type) {
+		case "JSXIdentifier": return name.name;
 		case "JSXMemberExpression": {
-			const { object, property } = name$1;
+			const { object, property } = name;
 			return resolveMemberExpressions(object, property);
 		}
-		case "JSXNamespacedName": return `${name$1.namespace.name}:${name$1.name.name}`;
+		case "JSXNamespacedName": return `${name.namespace.name}:${name.name.name}`;
 		default: throw new Error("Unsupported JSX node type.");
 	}
 }
@@ -101,20 +68,19 @@ function hasFbtParent(node) {
 function isFbtNode(node) {
 	if (!node) return null;
 	if (node.type === "JSXElement") {
-		const name$1 = elementType(node);
-		return name$1 === "fbt" || name$1 === "fbs" || name$1?.startsWith("fbt:");
+		const name = elementType(node);
+		return name === "fbt" || name === "fbs" || name?.startsWith("fbt:");
 	}
 	if (node.type === "CallExpression" && node.callee.type === "Identifier") {
-		const name$1 = node.callee.name;
-		return name$1 === "fbt" || name$1 === "fbs";
+		const name = node.callee.name;
+		return name === "fbt" || name === "fbs";
 	}
 	if (node.type === "MemberExpression" && node.object.type === "CallExpression" && node.object.callee.type === "Identifier") {
-		const name$1 = node.object.callee.name;
-		return name$1 === "fbt" || name$1 === "fbs";
+		const name = node.object.callee.name;
+		return name === "fbt" || name === "fbs";
 	}
 	return false;
 }
-
 //#endregion
 //#region src/rules/no-empty-strings.tsx
 var no_empty_strings_default = createRule({
@@ -177,7 +143,6 @@ function validateChildren(node) {
 function isEmptyString(node) {
 	return resolveNodeValue(node)?.trim() === "";
 }
-
 //#endregion
 //#region src/rules/no-unhelpful-desc.tsx
 var no_unhelpful_desc_default = createRule({
@@ -248,7 +213,6 @@ var no_unhelpful_desc_default = createRule({
 	},
 	name: "no-unhelpful-desc"
 });
-
 //#endregion
 //#region src/rules/no-untranslated-strings.tsx
 const attributes = new Set([
@@ -328,7 +292,6 @@ var no_untranslated_strings_default = createRule({
 	},
 	name: "no-untranslated-strings"
 });
-
 //#endregion
 //#region src/index.tsx
 var src_default = {
@@ -344,8 +307,8 @@ var src_default = {
 		} }
 	},
 	meta: {
-		name: package_default.name,
-		version: package_default.version
+		name,
+		version
 	},
 	rules: {
 		"no-empty-strings": no_empty_strings_default,
@@ -353,6 +316,5 @@ var src_default = {
 		"no-untranslated-strings": no_untranslated_strings_default
 	}
 };
-
 //#endregion
-export { src_default as default };
+export { src_default as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nkzw/eslint-plugin-fbtee",
-  "version": "1.7.0",
+  "version": "1.7.3",
   "description": "",
   "keywords": [],
   "repository": {
@@ -11,17 +11,16 @@
   "license": "MIT",
   "type": "module",
   "exports": {
-    "import": "./lib/index.js",
-    "require": "./lib/index.cjs"
+    "import": "./lib/index.mjs"
   },
-  "main": "lib/index.cjs",
+  "main": "lib/index.mjs",
   "dependencies": {
-    "@typescript-eslint/utils": "^8.46.0"
+    "@typescript-eslint/utils": "^8.56.1"
   },
   "devDependencies": {
-    "@typescript-eslint/rule-tester": "^8.46.0"
+    "@typescript-eslint/rule-tester": "^8.56.1"
   },
   "scripts": {
-    "build": "tsdown src/index.tsx -d lib --target=node22 --format=esm,cjs --clean --dts"
+    "build": "tsdown src/index.tsx -d lib --target=node22 --format=esm --clean --dts"
   }
 }

package/lib/index.cjs

@@ -1,382 +0,0 @@
-//#region rolldown:runtime
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
-		key = keys[i];
-		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
-			get: ((k) => from[k]).bind(null, key),
-			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
-		});
-	}
-	return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
-	value: mod,
-	enumerable: true
-}) : target, mod));
-
-//#endregion
-let __typescript_eslint_utils = require("@typescript-eslint/utils");
-__typescript_eslint_utils = __toESM(__typescript_eslint_utils);
-
-//#region package.json
-var name = "@nkzw/eslint-plugin-fbtee";
-var version = "1.7.0";
-var description = "";
-var keywords = [];
-var repository = {
-	"type": "git",
-	"url": "git+https://github.com/nkzw-tech/fbtee.git",
-	"directory": "packages/eslint-plugin-fbtee"
-};
-var license = "MIT";
-var type = "module";
-var exports$1 = {
-	"import": "./lib/index.js",
-	"require": "./lib/index.cjs"
-};
-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.46.0" };
-var devDependencies = { "@typescript-eslint/rule-tester": "^8.46.0" };
-var package_default = {
-	name,
-	version,
-	description,
-	keywords,
-	repository,
-	license,
-	type,
-	exports: exports$1,
-	main,
-	scripts,
-	dependencies,
-	devDependencies
-};
-
-//#endregion
-//#region src/utils.tsx
-const createRule = __typescript_eslint_utils.ESLintUtils.RuleCreator((name$1) => `https://github.com/nkzw-tech/fbtee/blob/main/packages/eslint-plugin-fbtee/docs/rules/${name$1}.md`);
-function resolveMemberExpressions(object, property) {
-	if (object.type === "JSXMemberExpression") return `${resolveMemberExpressions(object.object, object.property)}.${property.name}`;
-	return `${object.name}.${property.name}`;
-}
-function elementType(node) {
-	if (node.type === "JSXFragment") return "<>";
-	const { name: name$1 } = node.openingElement;
-	switch (name$1.type) {
-		case "JSXIdentifier": return name$1.name;
-		case "JSXMemberExpression": {
-			const { object, property } = name$1;
-			return resolveMemberExpressions(object, property);
-		}
-		case "JSXNamespacedName": return `${name$1.namespace.name}:${name$1.name.name}`;
-		default: throw new Error("Unsupported JSX node type.");
-	}
-}
-function resolveJsxElementTextContent(node) {
-	return node.children.map((child) => {
-		if (child.type === "JSXText") return child.value.trim();
-		if (child.type === "JSXExpressionContainer") return resolveNodeValue(child.expression) || "";
-		return "";
-	}).join("").trim();
-}
-function resolveBinaryExpression(node) {
-	if (node.operator !== "+") return null;
-	const leftValue = resolveNodeValue(node.left);
-	const rightValue = resolveNodeValue(node.right);
-	if (leftValue !== null && rightValue !== null) return leftValue + rightValue;
-	return null;
-}
-function resolveNodeValue(node) {
-	if (node.type === "Literal" && typeof node.value === "string") return node.value;
-	if (node.type === "TemplateLiteral" && node.expressions.length === 0) return node.quasis.map((quasi) => quasi.value.raw).join("");
-	if (node.type === "BinaryExpression") return resolveBinaryExpression(node);
-	if (node.type === "JSXExpressionContainer") return resolveNodeValue(node.expression);
-	if (node.type === "ConditionalExpression") {
-		const consequent = resolveNodeValue(node.consequent);
-		const alternate = resolveNodeValue(node.alternate);
-		return consequent || alternate || null;
-	}
-	if (node.type === "LogicalExpression") {
-		const left = resolveNodeValue(node.left);
-		const right = resolveNodeValue(node.right);
-		return left || right || null;
-	}
-	return null;
-}
-function getPropName(prop) {
-	if (prop.name.type === "JSXNamespacedName") return `${prop.name.namespace.name}:${prop.name.name.name}`;
-	return prop.name.name;
-}
-function hasFbtParent(node) {
-	let current = node.parent;
-	while (current) {
-		if (isFbtNode(current)) return true;
-		current = current.parent;
-	}
-	return false;
-}
-function isFbtNode(node) {
-	if (!node) return null;
-	if (node.type === "JSXElement") {
-		const name$1 = elementType(node);
-		return name$1 === "fbt" || name$1 === "fbs" || name$1?.startsWith("fbt:");
-	}
-	if (node.type === "CallExpression" && node.callee.type === "Identifier") {
-		const name$1 = node.callee.name;
-		return name$1 === "fbt" || name$1 === "fbs";
-	}
-	if (node.type === "MemberExpression" && node.object.type === "CallExpression" && node.object.callee.type === "Identifier") {
-		const name$1 = node.object.callee.name;
-		return name$1 === "fbt" || name$1 === "fbs";
-	}
-	return false;
-}
-
-//#endregion
-//#region src/rules/no-empty-strings.tsx
-var no_empty_strings_default = createRule({
-	create(context) {
-		return {
-			CallExpression(node) {
-				if (!isFbtNode(node)) return;
-				const [text] = node.arguments;
-				if (text && text.type !== "SpreadElement" && isEmptyString(text)) context.report({
-					messageId: "emptyString",
-					node: text
-				});
-			},
-			JSXElement(node) {
-				if (!isFbtNode(node)) return;
-				if (node.openingElement.name.type === "JSXNamespacedName") return;
-				if (!validateChildren(node)) context.report({
-					messageId: "jsxEmptyString",
-					node
-				});
-			}
-		};
-	},
-	defaultOptions: [],
-	meta: {
-		docs: { description: "Disallow empty strings in fbt elements or function calls." },
-		messages: {
-			emptyString: "Empty strings are not allowed in fbt() and fbs() function arguments.",
-			jsxEmptyString: "Empty strings are not allowed as children of `<fbt>` and `<fbs>` tags."
-		},
-		schema: [],
-		type: "problem"
-	},
-	name: "no-empty-strings"
-});
-function validateChildren(node) {
-	let hasTextContent = false;
-	for (const child of node.children) {
-		if (child.type === "JSXText" && child.value.trim() !== "") hasTextContent = true;
-		if (child.type === "JSXExpressionContainer") {
-			if (child.expression.type === "JSXEmptyExpression") continue;
-			if (child.expression.type === "Identifier" && child.expression.name !== "undefined") {
-				hasTextContent = true;
-				continue;
-			}
-			if (resolveNodeValue(child.expression)?.trim()) hasTextContent = true;
-		}
-		if (child.type === "JSXElement" || child.type === "JSXFragment") {
-			const childName = elementType(child);
-			if (/^[A-Z]/.test(childName) || childName.startsWith("fbt:")) {
-				hasTextContent = true;
-				continue;
-			}
-			hasTextContent ||= validateChildren(child);
-		}
-		if (hasTextContent) break;
-	}
-	return hasTextContent;
-}
-function isEmptyString(node) {
-	return resolveNodeValue(node)?.trim() === "";
-}
-
-//#endregion
-//#region src/rules/no-unhelpful-desc.tsx
-var no_unhelpful_desc_default = createRule({
-	create(context) {
-		return {
-			CallExpression(node) {
-				if (!isFbtNode(node)) return;
-				const [textArg, descArg] = node.arguments;
-				const desc = descArg && descArg.type !== "SpreadElement" ? resolveNodeValue(descArg)?.trim() : null;
-				if (!desc) {
-					context.report({
-						messageId: "emptyDesc",
-						node: descArg || node
-					});
-					return;
-				}
-				if (desc.length <= 4) {
-					context.report({
-						messageId: "shortDesc",
-						node: descArg || node
-					});
-					return;
-				}
-				const text = textArg && textArg.type !== "SpreadElement" ? resolveNodeValue(textArg)?.trim() : null;
-				if (desc.toLowerCase() === text?.toLowerCase()) context.report({
-					messageId: "duplicateDesc",
-					node: descArg || node
-				});
-			},
-			JSXAttribute(node) {
-				if (!isFbtNode(node.parent.parent)) return;
-				if (node.name.name !== "desc" || !node.value) return;
-				if (node.value.type === "JSXExpressionContainer" && (node.value.expression.type === "Identifier" || node.value.expression.type === "CallExpression")) return;
-				const desc = resolveNodeValue(node.value)?.trim();
-				if (!desc) {
-					context.report({
-						messageId: "jsxEmptyDesc",
-						node: node.value
-					});
-					return;
-				}
-				if (desc.length <= 4) {
-					context.report({
-						messageId: "shortDesc",
-						node: node.value
-					});
-					return;
-				}
-				const textContent = resolveJsxElementTextContent(node.parent.parent);
-				if (desc.toLowerCase() === textContent.toLowerCase()) context.report({
-					messageId: "duplicateDesc",
-					node: node.value
-				});
-			}
-		};
-	},
-	defaultOptions: [],
-	meta: {
-		docs: { description: "Enforce meaningful and non-empty descriptions in <fbt> elements and fbt()/fbs() function calls." },
-		messages: {
-			duplicateDesc: "The \"desc\" attribute or argument should not be a duplicate of the text content.",
-			emptyDesc: "The \"desc\" argument in fbt() and fbs() must not be empty.",
-			jsxEmptyDesc: "The \"desc\" attribute in <fbt> must not be empty.",
-			shortDesc: "The \"desc\" attribute or argument is too short. Use a more descriptive and meaningful explanation."
-		},
-		schema: [],
-		type: "problem"
-	},
-	name: "no-unhelpful-desc"
-});
-
-//#endregion
-//#region src/rules/no-untranslated-strings.tsx
-const attributes = new Set([
-	"title",
-	"placeholder",
-	"alt",
-	"label",
-	"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((value) => value.trim().toLowerCase()));
-		const isIgnoredWord = (value) => ignoredWords.has(value.replaceAll(/\s+/g, " ").toLowerCase());
-		return {
-			JSXAttribute(node) {
-				const propName = getPropName(node);
-				if (!attributes.has(propName)) return;
-				const value = node.value ? resolveNodeValue(node.value) : null;
-				if (!value) return;
-				if (isIgnoredWord(value)) return;
-				if (node.value?.type === "JSXExpressionContainer" && isFbtNode(node.value.expression)) return;
-				context.report({
-					messageId: "unwrappedString",
-					node
-				});
-			},
-			JSXExpressionContainer(node) {
-				if (node.parent.type === "JSXAttribute") return;
-				const value = resolveNodeValue(node.expression);
-				if (!value) return;
-				if (isIgnoredWord(value)) return;
-				if (shouldIgnoreParent(node)) return;
-				if (!hasFbtParent(node)) context.report({
-					messageId: "unwrappedString",
-					node
-				});
-			},
-			JSXText(node) {
-				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;
-					context.report({
-						loc: {
-							end: context.sourceCode.getLocFromIndex(endOffset),
-							start: context.sourceCode.getLocFromIndex(startOffset)
-						},
-						messageId: "unwrappedString"
-					});
-				}
-			}
-		};
-	},
-	defaultOptions: [{ ignoredWords: [] }],
-	meta: {
-		docs: { description: "Enforce text content to be wrapped with `<fbt>`, `fbt()` or `fbs()`" },
-		messages: { unwrappedString: "Text content must be wrapped in `<fbt>`, `fbt()` or `fbs()`" },
-		schema: [{
-			additionalProperties: false,
-			properties: { ignoredWords: {
-				items: { type: "string" },
-				type: "array",
-				uniqueItems: true
-			} },
-			type: "object"
-		}],
-		type: "problem"
-	},
-	name: "no-untranslated-strings"
-});
-
-//#endregion
-//#region src/index.tsx
-var src_default = {
-	configs: {
-		recommended: { rules: {
-			"@nkzw/fbtee/no-empty-strings": 2,
-			"@nkzw/fbtee/no-unhelpful-desc": 2
-		} },
-		strict: { rules: {
-			"@nkzw/fbtee/no-empty-strings": 2,
-			"@nkzw/fbtee/no-unhelpful-desc": 2,
-			"@nkzw/fbtee/no-untranslated-strings": 2
-		} }
-	},
-	meta: {
-		name: package_default.name,
-		version: package_default.version
-	},
-	rules: {
-		"no-empty-strings": no_empty_strings_default,
-		"no-unhelpful-desc": no_unhelpful_desc_default,
-		"no-untranslated-strings": no_untranslated_strings_default
-	}
-};
-
-//#endregion
-module.exports = src_default;

package/lib/index.d.cts

@@ -1,32 +0,0 @@
-import * as _typescript_eslint_utils_ts_eslint0 from "@typescript-eslint/utils/ts-eslint";
-
-//#region src/index.d.ts
-declare const _default: {
-  configs: {
-    recommended: {
-      rules: {
-        '@nkzw/fbtee/no-empty-strings': number;
-        '@nkzw/fbtee/no-unhelpful-desc': number;
-      };
-    };
-    strict: {
-      rules: {
-        '@nkzw/fbtee/no-empty-strings': number;
-        '@nkzw/fbtee/no-unhelpful-desc': number;
-        '@nkzw/fbtee/no-untranslated-strings': number;
-      };
-    };
-  };
-  meta: {
-    name: string;
-    version: string;
-  };
-  rules: {
-    'no-empty-strings': _typescript_eslint_utils_ts_eslint0.RuleModule<"emptyString" | "jsxEmptyString", [], unknown, _typescript_eslint_utils_ts_eslint0.RuleListener>;
-    'no-unhelpful-desc': _typescript_eslint_utils_ts_eslint0.RuleModule<"emptyDesc" | "jsxEmptyDesc" | "duplicateDesc" | "shortDesc", [], unknown, _typescript_eslint_utils_ts_eslint0.RuleListener>;
-    'no-untranslated-strings': _typescript_eslint_utils_ts_eslint0.RuleModule<"unwrappedString", [{
-      ignoredWords: Array<string>;
-    }], unknown, _typescript_eslint_utils_ts_eslint0.RuleListener>;
-  };
-};
-export = _default;