@akinon/eslint-plugin-projectzero 1.104.0 → 1.105.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @akinon/eslint-plugin-projectzero
 
+## 1.105.0
+
+### Minor Changes
+
+- 62779ee: ZERO-3668: Refactor check-menu-depth rule to simplify depth validation logic and remove unused error messages
+
 ## 1.104.0
 
 ## 1.103.0

package/dist/rules/check-menu-depth.js

@@ -8,33 +8,21 @@ exports.default = utils_1.ESLintUtils.RuleCreator.withoutDocs({
             CallExpression(node) {
                 const { callee, arguments: args } = node;
                 if (callee.type !== types_1.AST_NODE_TYPES.Identifier ||
-                    callee.name !== 'getMenu') {
+                    callee.name !== 'getMenu' ||
+                    args.length === 0 ||
+                    args[0].type !== types_1.AST_NODE_TYPES.ObjectExpression) {
                     return;
                 }
-                if (args.length === 0) {
-                    context.report({
-                        node: callee,
-                        messageId: 'noDepthMessage'
-                    });
-                    return;
-                }
-                if (args[0].type !== types_1.AST_NODE_TYPES.ObjectExpression) {
-                    return;
-                }
-                const depthProperty = args[0].properties.find((prop) => prop.type === types_1.AST_NODE_TYPES.Property &&
-                    prop.key.type === types_1.AST_NODE_TYPES.Identifier &&
-                    prop.key.name === 'depth');
-                if (!depthProperty) {
-                    context.report({
-                        node: args[0],
-                        messageId: 'noDepthMessage'
-                    });
-                    return;
-                }
-                if (depthProperty.type === types_1.AST_NODE_TYPES.Property &&
-                    depthProperty.value.type === types_1.AST_NODE_TYPES.Literal &&
-                    typeof depthProperty.value.value === 'number' &&
-                    depthProperty.value.value > 3) {
+                const depthProperty = args[0].properties.find((prop) => {
+                    var _a;
+                    return prop.type === types_1.AST_NODE_TYPES.Property &&
+                        prop.key.type === types_1.AST_NODE_TYPES.Identifier &&
+                        prop.key.name === 'depth' &&
+                        ((_a = prop.value) === null || _a === void 0 ? void 0 : _a.type) === types_1.AST_NODE_TYPES.Literal &&
+                        typeof prop.value.value === 'number' &&
+                        prop.value.value > 3;
+                });
+                if (depthProperty) {
                     context.report({
                         node: depthProperty,
                         messageId: 'depthMessage'
@@ -47,8 +35,7 @@ exports.default = utils_1.ESLintUtils.RuleCreator.withoutDocs({
         type: 'problem',
         fixable: 'code',
         messages: {
-            depthMessage: 'A request for a menu deeper than 3 levels from the server can lead to unnecessary memory usage and unwanted outcomes. Therefore, sending a request for a 3-level menu on the client side and making additional requests on hover for deeper levels may be more efficient.',
-            noDepthMessage: 'Calling getMenu() without a depth parameter fetches the entire menu, which can cause performance and memory issues. Please provide a depth parameter (maximum 3).'
+            depthMessage: 'A request for a menu deeper than 3 levels from the server can lead to unnecessary memory usage and unwanted outcomes. Therefore, sending a request for a 3-level menu on the client side and making additional requests on hover for deeper levels may be more efficient.'
         },
         schema: []
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akinon/eslint-plugin-projectzero",
-  "version": "1.104.0",
+  "version": "1.105.0",
   "private": false,
   "description": "ESLint plugin for Project Zero Next",
   "main": "dist/index.js",

package/rules/check-menu-depth.ts

@@ -9,44 +9,24 @@ export default ESLintUtils.RuleCreator.withoutDocs({
 
         if (
           callee.type !== AST_NODE_TYPES.Identifier ||
-          callee.name !== 'getMenu'
+          callee.name !== 'getMenu' ||
+          args.length === 0 ||
+          args[0].type !== AST_NODE_TYPES.ObjectExpression
         ) {
           return;
         }
 
-        if (args.length === 0) {
-          context.report({
-            node: callee,
-            messageId: 'noDepthMessage'
-          });
-          return;
-        }
-
-        if (args[0].type !== AST_NODE_TYPES.ObjectExpression) {
-          return;
-        }
-
         const depthProperty = args[0].properties.find(
           (prop) =>
             prop.type === AST_NODE_TYPES.Property &&
             prop.key.type === AST_NODE_TYPES.Identifier &&
-            prop.key.name === 'depth'
+            prop.key.name === 'depth' &&
+            prop.value?.type === AST_NODE_TYPES.Literal &&
+            typeof prop.value.value === 'number' &&
+            prop.value.value > 3
         );
 
-        if (!depthProperty) {
-          context.report({
-            node: args[0],
-            messageId: 'noDepthMessage'
-          });
-          return;
-        }
-
-        if (
-          depthProperty.type === AST_NODE_TYPES.Property &&
-          depthProperty.value.type === AST_NODE_TYPES.Literal &&
-          typeof depthProperty.value.value === 'number' &&
-          depthProperty.value.value > 3
-        ) {
+        if (depthProperty) {
           context.report({
             node: depthProperty,
             messageId: 'depthMessage'
@@ -60,9 +40,7 @@ export default ESLintUtils.RuleCreator.withoutDocs({
     fixable: 'code',
     messages: {
       depthMessage:
-        'A request for a menu deeper than 3 levels from the server can lead to unnecessary memory usage and unwanted outcomes. Therefore, sending a request for a 3-level menu on the client side and making additional requests on hover for deeper levels may be more efficient.',
-      noDepthMessage:
-        'Calling getMenu() without a depth parameter fetches the entire menu, which can cause performance and memory issues. Please provide a depth parameter (maximum 3).'
+        'A request for a menu deeper than 3 levels from the server can lead to unnecessary memory usage and unwanted outcomes. Therefore, sending a request for a 3-level menu on the client side and making additional requests on hover for deeper levels may be more efficient.'
     },
     schema: []
   },