@bigbinary/eslint-plugin-neeto 1.1.15 → 1.1.17

package/README.md

@@ -46,6 +46,8 @@ module.exports = {
 
 ## Exported rules
 
+- [no-withT-for-smart-components](./docs/src/rules/no-withT-for-smart-components.md)
+- [no-large-functions-inside-jsx](./docs/src/rules/no-large-functions-inside-jsx.md)
 - [use-standard-date-time-formats](./docs/src/rules/use-standard-date-time-formats.md)
 - [no-dumb-components-with-use-translation](./docs/src/rules/no-dumb-components-with-use-translation.md)
 - [no-unnecessary-if-condition](./docs/src/rules/no-unnecessary-if-condition.md)

package/dist/index.js

@@ -42,6 +42,8 @@
   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-withT-for-smart-components": "error",
+    "@bigbinary/neeto/no-large-functions-inside-jsx": "error",
     "@bigbinary/neeto/use-standard-date-time-formats": "error",
     "@bigbinary/neeto/no-dumb-components-with-use-translation": "error",
     "@bigbinary/neeto/api-connector-name-should-match-filename": "error",
@@ -406,7 +408,19 @@
       }
     }]
   };
+  var PROP_FUNCTION_PATTERN = {
+    value: {
+      type: TYPES.JSX_EXPRESSION_CONTAINER,
+      expression: {
+        type: TYPES.ARROW_FUNCTION_EXPRESSION,
+        body: {
+          type: TYPES.BLOCK_STATEMENT
+        }
+      }
+    }
+  };
   var NO_OF_LINES_ALLOWED_FOR_MULTIPLE_COMPONENTS_IN_A_FILE = 20;
+  var MAX_LINES_FOR_FUNCTIONS_INSIDE_JSX = 4;
 
   var ARGUMENT_LIMIT = 3;
   var API_ACTIONS_ARGUMENT_LIMIT = 2;
@@ -458,6 +472,10 @@
     var maxAllowedNoOfLines = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 20;
     return "Do not have multiple component definitions that exceed ".concat(maxAllowedNoOfLines, " lines in a single file.");
   };
+  var avoidLargeFunctionsInsideJsx = function avoidLargeFunctionsInsideJsx() {
+    var maxAllowedNoOfLines = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 4;
+    return "Avoid inline functions that exceed ".concat(maxAllowedNoOfLines, " lines directly inside JSX. Extract the function outside of JSX.");
+  };
   var suggestNeetoCommonsFunctionsAndHooks = function suggestNeetoCommonsFunctionsAndHooks(functionName, utilType, url) {
     return "Use \"".concat(functionName, "\" from \"@bigbinary/neeto-commons-frontend/").concat(utilType, "\" instead. Refer: ").concat(url);
   };
@@ -527,6 +545,7 @@
   var PROP_KEY_VALUE_DUPLICATE = "Prop key and value names should not be repeated";
   var USE_WITH_IMMUTABLE_ACTIONS_WRAPPER = 'Use "withImmutableActions" wrapper from "neeto-commons-frontend" inside zustand create. Refer: https://bit.ly/withimmutableactions';
   var USE_WITH_T_HOC_IN_DUMB_COMPONENTS = 'Use "withT" HOC from "neeto-commons-frontend" instead of useTranslation hook in Dumb components';
+  var NO_WITH_T_IN_SMART_COMPONENTS = '"withT" HOC should only be used in dumb components. "useTranslation" hook should be used here.';
   var USE_STANDARD_DATE_TIME_FORMATS = 'Use "dateFormat/timeFormat" from "@bigbinary/neeto-commons-frontend/utils" instead. Refer: https://github.com/bigbinary/neeto-commons-frontend/blob/main/docs/utils/README.md#dateformattimeformat';
 
   var PACKAGES_TO_CHECK = ["@bigbinary/neeto-molecules", "@bigbinary/neetoui", "@bigbinary/neeto-commons-frontend"];
@@ -6088,6 +6107,35 @@
     }
   };
 
+  var noLargeFunctionsInsideJsx = {
+    meta: {
+      type: "problem",
+      docs: {
+        url: "https://github.com/bigbinary/eslint-plugin-neeto/blob/main/docs/src/rules/no-large-functions-inside-jsx.md",
+        description: "Disallows the use of functions with large bodies, that exceed maxAllowedNoOfLines, directly inside JSX elements." + "The default value for maxAllowedNoOfLines is 4."
+      }
+    },
+    create: function create(context) {
+      return {
+        JSXAttribute: function JSXAttribute(node) {
+          var _context$options$;
+          if (!pure.matches(PROP_FUNCTION_PATTERN, node)) return;
+          var functionBody = node.value.expression.body;
+          var _functionBody$loc = functionBody.loc,
+            start = _functionBody$loc.start,
+            end = _functionBody$loc.end;
+          var linesInsideBlock = end.line - (start.line + 1);
+          var maxAllowedNoOfLines = ((_context$options$ = context.options[0]) === null || _context$options$ === void 0 ? void 0 : _context$options$.maxAllowedNoOfLines) || MAX_LINES_FOR_FUNCTIONS_INSIDE_JSX;
+          if (linesInsideBlock <= maxAllowedNoOfLines) return;
+          context.report({
+            node: node,
+            message: avoidLargeFunctionsInsideJsx(maxAllowedNoOfLines)
+          });
+        }
+      };
+    }
+  };
+
   var noMultipleComponentsInAFile = {
     meta: {
       type: "problem",
@@ -6441,6 +6489,110 @@
     }
   };
 
+  var REACT_I18_IMPORT_PATTERN = {
+    type: TYPES.IMPORT_DECLARATION,
+    source: {
+      type: TYPES.LITERAL,
+      value: "react-i18next"
+    },
+    specifiers: [{
+      type: TYPES.IMPORT_SPECIFIER
+    }]
+  };
+  var WITH_T_HOC_PATTERN = {
+    type: TYPES.VARIABLE_DECLARATION,
+    kind: "const",
+    declarations: [{
+      type: TYPES.VARIABLE_DECLARATOR,
+      init: {
+        type: TYPES.CALL_EXPRESSION,
+        callee: {
+          name: "withT"
+        },
+        arguments: [{
+          body: {
+            type: TYPES.BLOCK_STATEMENT,
+            body: function body(_body) {
+              return _body.length >= 2;
+            }
+          }
+        }]
+      },
+      id: {
+        type: TYPES.IDENTIFIER,
+        name: ramda.test(PASCAL_CASE_REGEX)
+      }
+    }]
+  };
+
+  var insertTextAfterPosition = function insertTextAfterPosition(position, inputString, textToInsert) {
+    var firstCharacter = inputString.charAt(position);
+    var restOfString = inputString.slice(position + 1);
+    return firstCharacter + textToInsert + restOfString;
+  };
+
+  var noWithTForSmartComponents = {
+    meta: {
+      type: "problem",
+      docs: {
+        url: "https://github.com/bigbinary/eslint-plugin-neeto/blob/main/docs/src/rules/no-withT-for-smart-components.md",
+        description: "Disallows usage of 'withT' HOC in smart components."
+      },
+      fixable: "code"
+    },
+    create: function create(context) {
+      return {
+        VariableDeclaration: function VariableDeclaration(node) {
+          if (!pure.matches(WITH_T_HOC_PATTERN, node)) return;
+          var arrowFunctionExpression = node.declarations[0].init.arguments[0];
+          var body = arrowFunctionExpression.body;
+          context.report({
+            node: node,
+            message: NO_WITH_T_IN_SMART_COMPONENTS,
+            fix: function fix(fixer) {
+              var fixers = [];
+              var _arrowFunctionExpress = _toArray(arrowFunctionExpression.params),
+                props = _arrowFunctionExpress[0],
+                restParams = _arrowFunctionExpress.slice(1);
+              var getPropsCode = function getPropsCode() {
+                if (ramda.isEmpty(arrowFunctionExpression.params)) return "";
+                if (props.type === TYPES.IDENTIFIER) {
+                  return "{...".concat(getCode$1(context, props), " }");
+                }
+                if (props.type === TYPES.OBJECT_PATTERN) {
+                  var _props$properties, _props$properties2, _props$properties2$0$;
+                  if (((_props$properties = props.properties) === null || _props$properties === void 0 ? void 0 : _props$properties.length) === 1 && ((_props$properties2 = props.properties) === null || _props$properties2 === void 0 ? void 0 : (_props$properties2$0$ = _props$properties2[0].value) === null || _props$properties2$0$ === void 0 ? void 0 : _props$properties2$0$.name) === "t") {
+                    return "";
+                  }
+                  return "{".concat(props.properties.map(function (property) {
+                    return getCode$1(context, property);
+                  }).filter(pure.isNot("t")).join(", "), " }");
+                }
+                return "";
+              };
+              var codeInsideBody = getCode$1(context, body);
+              var codeWithUseTranslation = insertTextAfterPosition(0, codeInsideBody, "const { t } = useTranslation();\n");
+              var updatedProps = getPropsCode();
+              var replacedCodeWithUseTranslation = "(".concat(updatedProps).concat(ramda.isEmpty(restParams) ? "" : "".concat(pure.isNotEmpty(updatedProps) ? ", " : "").concat(restParams.map(function (param) {
+                return getCode$1(context, param);
+              }).join(", ")), ") => ").concat(codeWithUseTranslation);
+              var replaceIncorrectWithTCode = fixer.replaceText(node.declarations[0].init, replacedCodeWithUseTranslation);
+              fixers.push(replaceIncorrectWithTCode);
+              var importUseTranslation = addFunctionImport({
+                context: context,
+                fixer: fixer,
+                functions: ["useTranslation"],
+                importPattern: REACT_I18_IMPORT_PATTERN
+              });
+              importUseTranslation && fixers.push(importUseTranslation);
+              return fixers;
+            }
+          });
+        }
+      };
+    }
+  };
+
   var NEETO_PACKAGES = ["@bigbinary/neetoui", "@bigbinary/neeto-icons"];
 
   var importedFromNeeto = function importedFromNeeto(context, node) {
@@ -26568,6 +26720,8 @@
 
   var index = {
     rules: {
+      "no-withT-for-smart-components": noWithTForSmartComponents,
+      "no-large-functions-inside-jsx": noLargeFunctionsInsideJsx,
       "use-standard-date-time-formats": useStandardDateTimeFormats,
       "no-dumb-components-with-use-translation": noDumbComponentsWithUseTranslation,
       "api-connector-name-should-match-filename": apiConnectorNameShouldMatchFilename,

package/package.json

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