@agilebot/eslint-plugin 0.9.3 → 0.9.5

package/LICENSE

@@ -1,9 +1,9 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 Agilebot, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2024 Agilebot, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/index.mjs

@@ -5,16 +5,19 @@ import * as path$1 from "node:path";
 import path from "node:path";
 import { isCamelCase, isPascalCase, tsImport } from "@agilebot/eslint-utils";
 import * as Components from "eslint-plugin-react/lib/util/Components.js";
-
-//#region rolldown:runtime
-var __require = /* @__PURE__ */ createRequire(import.meta.url);
-
+//#region \0rolldown/runtime.js
+var __require = /* #__PURE__ */ (() => createRequire(import.meta.url))();
 //#endregion
 //#region src/util/rule.js
 const docBaseUrl = "https://github.com/sh-agilebot/frontend-toolkit/blob/master/packages/eslint-plugin/src/rules/";
-const hasDocs = [];
+const hasDocs = [
+	"enforce-mui-icon-alias",
+	"intl-id-missing",
+	"intl-id-prefix",
+	"intl-no-default",
+	"react-better-exhaustive-deps"
+];
 const createRule = ESLintUtils.RuleCreator((name) => hasDocs.includes(name) ? `${docBaseUrl}${name}.md` : `${docBaseUrl}${name}.test.js`);
-
 //#endregion
 //#region src/rules/enforce-mui-icon-alias.js
 const RULE_NAME$18 = "enforce-mui-icon-alias";
@@ -46,7 +49,6 @@ var enforce_mui_icon_alias_default = createRule({
 		} };
 	}
 });
-
 //#endregion
 //#region src/util/context.js
 /**
@@ -58,7 +60,6 @@ var enforce_mui_icon_alias_default = createRule({
 function getSetting(context, name) {
 	return context.settings[`agilebot/${name}`];
 }
-
 //#endregion
 //#region src/rules/import-monorepo.js
 const RULE_NAME$17 = "import-monorepo";
@@ -95,7 +96,6 @@ var import_monorepo_default = createRule({
 		} };
 	}
 });
-
 //#endregion
 //#region src/util/intl.js
 /**
@@ -151,7 +151,6 @@ function sortedTemplateElements(node) {
 function templateLiteralDisplayStr(node) {
 	return sortedTemplateElements(node).map((e) => !e.value ? "*" : e.value.raw).join("");
 }
-
 //#endregion
 //#region src/util/translations.js
 /**
@@ -192,7 +191,6 @@ function getIntlIds(context) {
 	});
 	return results;
 }
-
 //#endregion
 //#region src/rules/intl-id-missing.js
 const RULE_NAME$16 = "intl-id-missing";
@@ -259,7 +257,6 @@ var intl_id_missing_default = createRule({
 		};
 	}
 });
-
 //#endregion
 //#region src/rules/intl-id-naming.js
 const RULE_NAME$15 = "intl-id-naming";
@@ -325,7 +322,6 @@ var intl_id_naming_default = createRule({
 		};
 	}
 });
-
 //#endregion
 //#region src/rules/intl-id-prefix.js
 const RULE_NAME$14 = "intl-id-prefix";
@@ -378,7 +374,6 @@ var intl_id_prefix_default = createRule({
 		};
 	}
 });
-
 //#endregion
 //#region src/rules/intl-id-unused.js
 const RULE_NAME$13 = "intl-id-unused";
@@ -438,7 +433,6 @@ var intl_id_unused_default = createRule({
 		};
 	}
 });
-
 //#endregion
 //#region src/rules/intl-no-default.js
 const RULE_NAME$12 = "intl-no-default";
@@ -474,7 +468,6 @@ var intl_no_default_default = createRule({
 		};
 	}
 });
-
 //#endregion
 //#region src/rules/no-async-array-methods.js
 const RULE_NAME$11 = "no-async-array-methods";
@@ -521,7 +514,6 @@ var no_async_array_methods_default = createRule({
 		} };
 	}
 });
-
 //#endregion
 //#region src/rules/no-extends-error.js
 const RULE_NAME$10 = "no-extends-error";
@@ -546,7 +538,6 @@ var no_extends_error_default = createRule({
 		} };
 	}
 });
-
 //#endregion
 //#region src/rules/no-import-css.js
 const RULE_NAME$9 = "no-import-css";
@@ -573,7 +564,6 @@ var no_import_css_default = createRule({
 		} };
 	}
 });
-
 //#endregion
 //#region src/rules/no-then-catch-finally.js
 const RULE_NAME$8 = "no-then-catch-finally";
@@ -615,7 +605,12 @@ var no_then_catch_finally_default = createRule({
 		function isThenCatchFinally(node) {
 			return node.property && (node.property.name === "then" || node.property.name === "catch" || node.property.name === "finally");
 		}
-		return { [`${AST_NODE_TYPES.CallExpression} > ${AST_NODE_TYPES.MemberExpression}.callee`]: (node) => {
+		return { 
+		/**
+		* Reports a violation if a restricted function is used with then/catch/finally
+		* @param {*} node - The node to check
+		*/
+[`${AST_NODE_TYPES.CallExpression} > ${AST_NODE_TYPES.MemberExpression}.callee`]: (node) => {
 			if (isTopLevelScoped(node)) return;
 			if (!isThenCatchFinally(node)) return;
 			const callExpression = node.object;
@@ -627,7 +622,6 @@ var no_then_catch_finally_default = createRule({
 		} };
 	}
 });
-
 //#endregion
 //#region src/rules/no-unnecessary-template-literals.js
 const RULE_NAME$7 = "no-unnecessary-template-literals";
@@ -657,7 +651,6 @@ var no_unnecessary_template_literals_default = createRule({
 		} };
 	}
 });
-
 //#endregion
 //#region src/rules/react-better-exhaustive-deps.js
 /**
@@ -828,9 +821,9 @@ var react_better_exhaustive_deps_default = {
 				} else if (options.checkMemoizedVariableIsStatic && (name === "useMemo" || name === "useCallback")) {
 					const hookArgs = callee.parent.arguments;
 					if (hookArgs.length < 2) return false;
-					const dependencies$1 = hookArgs[1].elements;
-					if (dependencies$1.length === 0) return true;
-					for (const dependencyNode of dependencies$1) {
+					const dependencies = hookArgs[1].elements;
+					if (dependencies.length === 0) return true;
+					for (const dependencyNode of dependencies) {
 						const dependencyRefernece = resolved.scope.references.find((reference) => reference.identifier === dependencyNode);
 						if (dependencyRefernece !== void 0 && memoizedIsStableKnownHookValue(dependencyRefernece.resolved)) continue;
 						else return false;
@@ -967,7 +960,7 @@ var react_better_exhaustive_deps_default = {
 					});
 				});
 				if (setStateInsideEffectWithoutDeps) {
-					const { suggestedDependencies: suggestedDependencies$1 } = collectRecommendations({
+					const { suggestedDependencies } = collectRecommendations({
 						dependencies,
 						declaredDependencies: [],
 						stableDependencies,
@@ -976,11 +969,11 @@ var react_better_exhaustive_deps_default = {
 					});
 					reportProblem({
 						node: reactiveHook,
-						message: `React Hook ${reactiveHookName} contains a call to '${setStateInsideEffectWithoutDeps}'. Without a list of dependencies, this can lead to an infinite chain of updates. To fix this, pass [` + suggestedDependencies$1.join(", ") + `] as a second argument to the ${reactiveHookName} Hook.`,
+						message: `React Hook ${reactiveHookName} contains a call to '${setStateInsideEffectWithoutDeps}'. Without a list of dependencies, this can lead to an infinite chain of updates. To fix this, pass [` + suggestedDependencies.join(", ") + `] as a second argument to the ${reactiveHookName} Hook.`,
 						suggest: [{
-							desc: `Add dependencies array: [${suggestedDependencies$1.join(", ")}]`,
+							desc: `Add dependencies array: [${suggestedDependencies.join(", ")}]`,
 							fix(fixer) {
-								return fixer.insertTextAfter(node, `, [${suggestedDependencies$1.join(", ")}]`);
+								return fixer.insertTextAfter(node, `, [${suggestedDependencies.join(", ")}]`);
 							}
 						}]
 					});
@@ -1095,8 +1088,8 @@ var react_better_exhaustive_deps_default = {
 				return declaredDepKeys.join(",") === sortedDeclaredDepKeys.join(",");
 			}
 			if (areDeclaredDepsAlphabetized()) suggestedDeps.sort();
-			function formatDependency(path$2) {
-				const members = path$2.split(".");
+			function formatDependency(path) {
+				const members = path.split(".");
 				let finalPath = "";
 				for (let i = 0; i < members.length; i++) {
 					if (i !== 0) {
@@ -1340,8 +1333,8 @@ function collectRecommendations({ dependencies, declaredDependencies, stableDepe
 		const node = getOrCreateNodeByPath(depTree, key);
 		node.isSatisfiedRecursively = true;
 	});
-	function getOrCreateNodeByPath(rootNode, path$2) {
-		const keys = path$2.split(".");
+	function getOrCreateNodeByPath(rootNode, path) {
+		const keys = path.split(".");
 		let node = rootNode;
 		for (const key of keys) {
 			let child = node.children.get(key);
@@ -1353,8 +1346,8 @@ function collectRecommendations({ dependencies, declaredDependencies, stableDepe
 		}
 		return node;
 	}
-	function markAllParentsByPath(rootNode, path$2, fn) {
-		const keys = path$2.split(".");
+	function markAllParentsByPath(rootNode, path, fn) {
+		const keys = path.split(".");
 		let node = rootNode;
 		for (const key of keys) {
 			const child = node.children.get(key);
@@ -1368,16 +1361,16 @@ function collectRecommendations({ dependencies, declaredDependencies, stableDepe
 	scanTreeRecursively(depTree, missingDependencies, satisfyingDependencies, (key) => key);
 	function scanTreeRecursively(node, missingPaths, satisfyingPaths, keyToPath) {
 		node.children.forEach((child, key) => {
-			const path$2 = keyToPath(key);
+			const path = keyToPath(key);
 			if (child.isSatisfiedRecursively) {
-				if (child.isSubtreeUsed) satisfyingPaths.add(path$2);
+				if (child.isSubtreeUsed) satisfyingPaths.add(path);
 				return;
 			}
 			if (child.isUsed) {
-				missingPaths.add(path$2);
+				missingPaths.add(path);
 				return;
 			}
-			scanTreeRecursively(child, missingPaths, satisfyingPaths, (childKey) => path$2 + "." + childKey);
+			scanTreeRecursively(child, missingPaths, satisfyingPaths, (childKey) => path + "." + childKey);
 		});
 	}
 	const suggestedDependencies = [];
@@ -1606,7 +1599,6 @@ function isAncestorNodeOf(a, b) {
 function isUseEffectEventIdentifier(node) {
 	return false;
 }
-
 //#endregion
 //#region src/rules/react-hook-use-ref.js
 const RULE_NAME$5 = "react-hook-use-ref";
@@ -1632,7 +1624,6 @@ var react_hook_use_ref_default = createRule({
 		});
 	} }))
 });
-
 //#endregion
 //#region src/rules/react-prefer-sx-prop.js
 const RULE_NAME$4 = "react-prefer-sx-prop";
@@ -1683,7 +1674,6 @@ var react_prefer_sx_prop_default = createRule({
 		} };
 	}
 });
-
 //#endregion
 //#region src/util/tss.js
 /**
@@ -1758,7 +1748,6 @@ function loopStylesObj(node, callback) {
 		else callback(property.value);
 	});
 }
-
 //#endregion
 //#region src/rules/tss-class-naming.js
 const RULE_NAME$3 = "tss-class-naming";
@@ -1791,7 +1780,6 @@ var tss_class_naming_default = createRule({
 		} };
 	}
 });
-
 //#endregion
 //#region ../../node_modules/.pnpm/color-name@2.0.0/node_modules/color-name/index.js
 var color_name_default = {
@@ -2536,7 +2524,6 @@ var color_name_default = {
 		50
 	]
 };
-
 //#endregion
 //#region src/rules/tss-no-color-name.js
 const RULE_NAME$2 = "tss-no-color-name";
@@ -2566,7 +2553,6 @@ var tss_no_color_name_default = createRule({
 		} };
 	}
 });
-
 //#endregion
 //#region src/rules/tss-no-color-value.js
 const RULE_NAME$1 = "tss-no-color-value";
@@ -2598,7 +2584,6 @@ var tss_no_color_value_default = createRule({
 		} };
 	}
 });
-
 //#endregion
 //#region src/rules/tss-unused-classes.js
 const RULE_NAME = "tss-unused-classes";
@@ -2658,7 +2643,6 @@ var tss_unused_classes_default = createRule({
 		};
 	}
 });
-
 //#endregion
 //#region src/rules/index.js
 const rules = {
@@ -2682,13 +2666,18 @@ const rules = {
 	[RULE_NAME$1]: tss_no_color_value_default,
 	[RULE_NAME]: tss_unused_classes_default
 };
-
 //#endregion
 //#region src/index.js
 const plugin = {
+	/**
+	* @type {import('eslint').Linter.RulesRecord}
+	*/
 	rules: {},
 	configs: { recommended: {
 		plugins: ["@agilebot"],
+		/**
+		* @type {import('eslint').Linter.RulesRecord}
+		*/
 		rules: {},
 		settings: { react: { version: "18.0.0" } }
 	} }
@@ -2698,7 +2687,5 @@ Object.keys(rules).forEach((name) => {
 	plugin.rules[name] = rule;
 	if (rule.meta && rule.meta.docs && rule.meta.docs.recommended) plugin.configs.recommended.rules[`@agilebot/${name}`] = rule.meta.type === "problem" ? "error" : "warn";
 });
-var src_default = plugin;
-
 //#endregion
-export { src_default as default };
+export { plugin as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agilebot/eslint-plugin",
-  "version": "0.9.3",
+  "version": "0.9.5",
   "type": "module",
   "description": "Agilebot's ESLint plugin",
   "main": "./dist/index.mjs",
@@ -27,7 +27,7 @@
   "dependencies": {
     "@typescript-eslint/utils": "~8.29.0",
     "eslint-plugin-react": "^7.37.2",
-    "@agilebot/eslint-utils": "0.9.3"
+    "@agilebot/eslint-utils": "0.9.5"
   },
   "peerDependencies": {
     "eslint": "^9.0.0"