@bigbinary/eslint-plugin-neeto 1.1.34 → 1.1.36

package/README.md

@@ -46,6 +46,7 @@ module.exports = {
 
 ## Exported rules
 
+- [no-snake-case-destructuring-for-use-query-params-and-get-query-params](./docs/src/rules/no-snake-case-destructuring-for-use-query-params-and-get-query-params.md)
 - [no-local-storage](./docs/src/rules/no-local-storage.md)
 - [no-lowercase-on-translation](./docs/src/rules/no-lowercase-on-translation.md)
 - [use-use-query-client-hook](./docs/src/rules/use-use-query-client-hook.md)
@@ -120,6 +121,7 @@ module.exports = {
 - [zustand-use-with-immutable-actions-wrapper-inside-create](./docs/src/rules/zustand-use-with-immutable-actions-wrapper-inside-create.md)
 - [add-required-peer-dependencies](./docs/src/rules/add-required-peer-dependencies.md)
 - [move-spread-attributes-to-top-position](./docs/src/rules/move-spread-attributes-to-top-position.md)
+- [prefer-function-reference.md](./docs/src/rules/prefer-function-reference.md)
 
 ## Other references
 

package/dist/index.js

@@ -42,6 +42,7 @@
   var commonResolve$2 = loadJS$2("node_modules/@bigbinary/neeto-commons-frontend/configs/webpack/resolve.js");
   var resolve$2 = ramda.mergeDeepLeft(projectResolve$2, commonResolve$2);
   var rules = {
+    "@bigbinary/neeto/no-snake-case-destructuring-for-use-query-params-and-get-query-params": "warn",
     "@bigbinary/neeto/no-local-storage": "error",
     "@bigbinary/neeto/no-lowercase-on-translation": "warn",
     "@bigbinary/neeto/use-use-query-client-hook": "error",
@@ -160,7 +161,8 @@
     "@bigbinary/neeto/props-inside-spread-attributes-should-be-sorted": "error",
     "@bigbinary/neeto/props-with-different-key-value-should-be-outside-spread-attribute": "error",
     "@bigbinary/neeto/use-common-constants": "warn",
-    "@bigbinary/neeto/move-spread-attributes-to-top-position": "error"
+    "@bigbinary/neeto/move-spread-attributes-to-top-position": "error",
+    "@bigbinary/neeto/prefer-function-reference": "warn"
   };
 
   var recommended = {
@@ -560,6 +562,8 @@
   var USE_EARLY_RETURN = "Use early return to avoid nested statement";
   var NO_LOCAL_STORAGE = "Do not use localStorage directly. Use 'getFromLocalStorage()', 'setToLocalStorage()', 'removeFromLocalStorage()' or 'useLocalStorage()' from neeto-commons-frontend instead.";
   var NO_TRANSLATION_LOWERCASE = "No need to lowercase i18next translations";
+  var AVOID_SNAKE_CASE_DESTRUCTURING_USEQUERYPARAMS_OR_GETQUERYPARAMS = "Avoid destructuring snake-cased values from getQueryParams or useQueryParams";
+  var PREFER_FUNCTION_REFERENCE = "Prefer passing function reference instead of creating a new function as the parameters and arguments are the same.";
 
   var PACKAGES_TO_CHECK = ["@bigbinary/neeto-molecules", "@bigbinary/neetoui", "@bigbinary/neeto-commons-frontend"];
 
@@ -1311,7 +1315,7 @@
     }
   };
 
-  var checkAndReport$6 = function checkAndReport(context, node) {
+  var checkAndReport$7 = function checkAndReport(context, node) {
     if (!isInsideApisDirectory(context)) return;
     context.report({
       node: node,
@@ -1329,11 +1333,11 @@
     create: function create(context) {
       return {
         ExportNamedDeclaration: function ExportNamedDeclaration(node) {
-          checkAndReport$6(context, node);
+          checkAndReport$7(context, node);
         },
         ExportDefaultDeclaration: function ExportDefaultDeclaration(node) {
           if (node.declaration.type !== TYPES.OBJECT_EXPRESSION) return;
-          checkAndReport$6(context, node);
+          checkAndReport$7(context, node);
         }
       };
     }
@@ -1435,7 +1439,7 @@
       }
     });
   };
-  var checkAndReport$5 = function checkAndReport(context, node) {
+  var checkAndReport$6 = function checkAndReport(context, node) {
     if (!node.async) return;
     var subsequentAwaits = getIndependentAwaits(node);
     if (subsequentAwaits.length === 0) return;
@@ -1456,15 +1460,15 @@
       return {
         // const sum = (a, b) => a + b;
         ArrowFunctionExpression: function ArrowFunctionExpression(node) {
-          checkAndReport$5(context, node);
+          checkAndReport$6(context, node);
         },
         // const sum = function (a, b) { return a + b };
         FunctionExpression: function FunctionExpression(node) {
-          checkAndReport$5(context, node);
+          checkAndReport$6(context, node);
         },
         // function sum (a, b) { return a + b };
         FunctionDeclaration: function FunctionDeclaration(node) {
-          checkAndReport$5(context, node);
+          checkAndReport$6(context, node);
         }
       };
     }
@@ -4092,7 +4096,7 @@
     }
     return false;
   };
-  var checkAndReport$4 = function checkAndReport(node, context) {
+  var checkAndReport$5 = function checkAndReport(node, context) {
     if (!shouldReport(node, context)) return;
     context.report({
       node: node,
@@ -4110,13 +4114,13 @@
     create: function create(context) {
       return {
         Literal: function Literal(node) {
-          checkAndReport$4(node, context);
+          checkAndReport$5(node, context);
         },
         TemplateLiteral: function TemplateLiteral(node) {
-          checkAndReport$4(node, context);
+          checkAndReport$5(node, context);
         },
         JSXText: function JSXText(node) {
-          checkAndReport$4(node, context);
+          checkAndReport$5(node, context);
         }
       };
     }
@@ -4234,7 +4238,7 @@
       }, ramda.assoc("content", _objectSpread$2(_objectSpread$2({}, parseJsonData(path$2.join(translationsDirPath, changedFileName))), nanosContent[lng])), translationFiles);
     });
   };
-  var checkAndReport$3 = function checkAndReport(_ref) {
+  var checkAndReport$4 = function checkAndReport(_ref) {
     var _config$context, _config$count;
     var context = _ref.context,
       node = _ref.node,
@@ -4317,7 +4321,7 @@
             config.count = getObjectPropValue(node.arguments[1], "count");
             config.context = getObjectPropValue(node.arguments[1], "context");
           }
-          checkAndReport$3({
+          checkAndReport$4({
             key: node.arguments[0].value,
             context: context,
             node: node,
@@ -4335,7 +4339,7 @@
             count: getCountNode(node),
             context: contextAttribute === null || contextAttribute === void 0 ? void 0 : contextAttribute.value
           };
-          checkAndReport$3({
+          checkAndReport$4({
             key: keyNode.value,
             context: context,
             node: node,
@@ -6121,7 +6125,7 @@
       return getCode$1(context, param);
     }).join(", ");
   };
-  var checkAndReport$2 = function checkAndReport(context, params) {
+  var checkAndReport$3 = function checkAndReport(context, params) {
     var isApiAction = isInsideApisDirectory(context);
     if (!containsExcessArguments(params, isApiAction)) return;
     var loc = {
@@ -6153,15 +6157,15 @@
       return {
         // const sum = (a, b) => a + b;
         ArrowFunctionExpression: function ArrowFunctionExpression(node) {
-          checkAndReport$2(context, node.params);
+          checkAndReport$3(context, node.params);
         },
         // const sum = function (a, b) { return a + b };
         FunctionExpression: function FunctionExpression(node) {
-          checkAndReport$2(context, node.params);
+          checkAndReport$3(context, node.params);
         },
         // function sum (a, b) { return a + b };
         FunctionDeclaration: function FunctionDeclaration(node) {
-          checkAndReport$2(context, node.params);
+          checkAndReport$3(context, node.params);
         }
       };
     }
@@ -6551,6 +6555,58 @@
     }
   };
 
+  var SNAKE_CASE_WITHOUT_SINGLE_WORDS = /^[a-z]+_[a-z0-9_]+$/;
+  var PATTERN = {
+    id: {
+      type: "ObjectPattern",
+      properties: ramda.any(neetoCist.matches({
+        type: "Property",
+        key: {
+          name: ramda.test(SNAKE_CASE_WITHOUT_SINGLE_WORDS)
+        }
+      }))
+    },
+    init: {
+      type: "CallExpression",
+      callee: {
+        name: matchesAny(["getQueryParams", "useQueryParams"])
+      },
+      arguments: ramda.none(neetoCist.matches({
+        type: "ObjectExpression",
+        properties: ramda.any(neetoCist.matches({
+          key: {
+            name: "toCamelCase"
+          },
+          value: {
+            value: false
+          }
+        }))
+      }))
+    }
+  };
+
+  var noSnakeCaseDestructuringForUseQueryParamsAndGetQueryParams = {
+    meta: {
+      type: "warn",
+      docs: {
+        url: "https://github.com/bigbinary/eslint-plugin-neeto/blob/main/docs/src/rules/no-snake-case-destructuring-for-use-query-params-and-get-query-params.md",
+        description: "Prevent destructuring snake-cased values within the useQueryParams and getQueryParams function"
+      }
+    },
+    create: function create(context) {
+      return {
+        VariableDeclarator: function VariableDeclarator(node) {
+          if (neetoCist.matches(PATTERN, node)) {
+            context.report({
+              node: node,
+              message: AVOID_SNAKE_CASE_DESTRUCTURING_USEQUERYPARAMS_OR_GETQUERYPARAMS
+            });
+          }
+        }
+      };
+    }
+  };
+
   // if (condition) statement;
   var SINGLE_LINE_IF_CONDITION_PATTERN = {
     parent: {
@@ -6830,6 +6886,50 @@
     }
   };
 
+  var buildCodeArray = function buildCodeArray(_ref) {
+    var values = _ref.values,
+      context = _ref.context;
+    return values.map(function (value) {
+      return getCode$1(context, value).replace(/\s/g, "");
+    });
+  };
+  var checkAndReport$2 = function checkAndReport(context, node) {
+    // Don't catch arrow function JSX component declaration
+    if (node.body.type !== TYPES.CALL_EXPRESSION) return;
+    var params = buildCodeArray({
+      values: node.params,
+      context: context
+    });
+    var args = buildCodeArray({
+      values: node.body.arguments,
+      context: context
+    });
+    if (ramda.equals(params, args)) {
+      context.report({
+        node: node,
+        message: PREFER_FUNCTION_REFERENCE
+      });
+    }
+  };
+  var preferFunctionReference = {
+    meta: {
+      type: "suggestion",
+      docs: {
+        url: "https://github.com/bigbinary/eslint-plugin-neeto/blob/main/docs/src/rules/prefer-function-reference.md",
+        description: "Discourage creating a new function when the existing function can be passed as reference",
+        category: "Best Practices",
+        recommended: true
+      }
+    },
+    create: function create(context) {
+      return {
+        ArrowFunctionExpression: function ArrowFunctionExpression(node) {
+          checkAndReport$2(context, node);
+        }
+      };
+    }
+  };
+
   var NEETO_PACKAGES = ["@bigbinary/neetoui", "@bigbinary/neeto-icons"];
 
   var importedFromNeeto = function importedFromNeeto(context, node) {
@@ -10298,6 +10398,7 @@
 
   var index = {
     rules: {
+      "no-snake-case-destructuring-for-use-query-params-and-get-query-params": noSnakeCaseDestructuringForUseQueryParamsAndGetQueryParams,
       "no-local-storage": noLocalStorage,
       "no-lowercase-on-translation": noLowercaseOnTranslation,
       "use-use-query-client-hook": useUseQueryClientHook,
@@ -10373,7 +10474,8 @@
       "zustand-use-with-immutable-actions-wrapper-inside-create": useWithImmutableActionsWrapperInsideCreate,
       "add-required-peer-dependencies": addRequiredPeerDependencies,
       "use-common-constants": useCommonConstants,
-      "move-spread-attributes-to-top-position": moveSpreadAttributesToTopPosition
+      "move-spread-attributes-to-top-position": moveSpreadAttributesToTopPosition,
+      "prefer-function-reference": preferFunctionReference
     },
     configs: {
       recommended: recommended,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/eslint-plugin-neeto",
-  "version": "1.1.34",
+  "version": "1.1.36",
   "main": "dist/index.js",
   "license": "UNLICENSED",
   "scripts": {