@bigbinary/eslint-plugin-neeto 1.7.2 → 1.7.4

package/README.md

@@ -51,6 +51,7 @@ of the issues identified in JavaScript code.
 
 ### Errors
 
+- [switch-children-must-be-route-or-redirect](./docs/src/rules/switch-children-must-be-route-or-redirect.md)
 - [no-unnecessary-classnames](./docs/src/rules/no-unnecessary-classnames.md)
 - [no-local-storage](./docs/src/rules/no-local-storage.md)
 - [no-lowercase-on-translation](./docs/src/rules/no-lowercase-on-translation.md)

package/dist/index.js

@@ -23,6 +23,7 @@
 
   var neetoCommonsConstants__namespace = /*#__PURE__*/_interopNamespaceDefault(neetoCommonsConstants);
 
+  /* eslint-disable @bigbinary/neeto/use-title-case-neeto-in-strings */
   var absolutePath$1 = function absolutePath(jsPath) {
     return path$2.resolve(__dirname, "../../../..", jsPath);
   };
@@ -37,6 +38,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/switch-children-must-be-route-or-redirect": "error",
     "@bigbinary/neeto/use-dayjs-from-neeto-commons-fronted": "error",
     "@bigbinary/neeto/use-neetoui-action-block-in-formik-forms": "warn",
     "@bigbinary/neeto/no-unnecessary-classnames": "error",
@@ -322,7 +324,7 @@
   }
 
   var name = "@bigbinary/eslint-plugin-neeto";
-  var version = "1.7.1";
+  var version = "1.7.3";
   var main = "dist/index.js";
   var license = "UNLICENSED";
   var scripts = {
@@ -351,7 +353,7 @@
   	"@babel/preset-typescript": "^7.18.6",
   	"@babel/runtime": "^7.19.0",
   	"@bigbinary/babel-preset-neeto": "^1.0.3",
-  	"@bigbinary/eslint-plugin-neeto": "^1.6.2",
+  	"@bigbinary/eslint-plugin-neeto": "^1.7.2",
   	"@bigbinary/neeto-cist": "^1.0.3",
   	"@bigbinary/neeto-commons-frontend": "^4.13.42",
   	"@rollup/plugin-alias": "^3.1.9",
@@ -729,6 +731,7 @@
   };
   var HELP_URL_SHOULD_USE_PERMALINK = "Help URL must use a permalink (/p/...) instead of an article link (/articles/...).";
   var HELP_URL_INCORRECT_FORMAT = "Incorrect help URL format. Please use the 'help.neeto<product>.com' format instead of 'neeto<product>help.neetokb.com'.";
+  var INVALID_SWITCH_CHILD_MESSAGE = "Switch component can only contain Route, Redirect, or PrivateRoute as direct children";
 
   var PACKAGES_TO_CHECK = ["@bigbinary/neeto-molecules", "@bigbinary/neetoui", "@bigbinary/neeto-commons-frontend"];
 
@@ -10822,6 +10825,55 @@
     }
   };
 
+  var SWITCH_PATTERN = {
+    type: TYPES.JSX_ELEMENT,
+    openingElement: {
+      type: TYPES.JSX_OPENING_ELEMENT,
+      name: {
+        type: TYPES.JSX_IDENTIFIER,
+        name: "Switch"
+      }
+    }
+  };
+  var VALID_SWITCH_CHILDREN = ["Route", "Redirect", "PrivateRoute"];
+
+  var isValidSwitchChild = function isValidSwitchChild(child) {
+    if (child.type === TYPES.JSX_EXPRESSION_CONTAINER) return true;
+    if (child.type === TYPES.JSX_TEXT) {
+      var trimmedValue = child.value.trim();
+      return trimmedValue === "";
+    }
+    if (child.type === TYPES.JSX_ELEMENT) {
+      var _child$openingElement, _child$openingElement2;
+      var elementName = (_child$openingElement = child.openingElement) === null || _child$openingElement === void 0 ? void 0 : (_child$openingElement2 = _child$openingElement.name) === null || _child$openingElement2 === void 0 ? void 0 : _child$openingElement2.name;
+      return VALID_SWITCH_CHILDREN.includes(elementName);
+    }
+    return false;
+  };
+  var switchChildrenMustBeRouteOrRedirect = {
+    meta: {
+      type: "problem",
+      docs: {
+        url: "https://github.com/bigbinary/eslint-plugin-neeto/blob/main/docs/src/rules/switch-children-must-be-route-or-redirect.md",
+        description: "Enforces that Switch components can only contain Route or Redirect as direct children"
+      }
+    },
+    create: function create(context) {
+      return {
+        JSXElement: function JSXElement(node) {
+          if (!neetoCist.matches(SWITCH_PATTERN, node)) return;
+          node.children.forEach(function (child) {
+            if (isValidSwitchChild(child)) return;
+            context.report({
+              node: child,
+              message: INVALID_SWITCH_CHILD_MESSAGE
+            });
+          });
+        }
+      };
+    }
+  };
+
   var isForLoopReplacable = function isForLoopReplacable(node) {
     return ramda.not(patternExistsDeep(BREAK_STATEMENT_PATTERN, node.body) || patternExistsDeep(RETURN_STATEMENT_PATTERN$1, node.body) || patternExistsDeep(CHAR_AT_PATTERN, node.body));
   };
@@ -11701,6 +11753,16 @@
   };
   var CONDITIONAL_NODE_TYPES = [TYPES.LOGICAL_EXPRESSION, TYPES.CONDITIONAL_EXPRESSION];
   var NODE_TYPES = [TYPES.JSX_ELEMENT, TYPES.JSX_EXPRESSION_CONTAINER];
+  var HTML_FORM_ELEMENT_PATTERN = {
+    type: TYPES.JSX_ELEMENT,
+    openingElement: {
+      name: {
+        name: function name(_name3) {
+          return _name3 === null || _name3 === void 0 ? void 0 : _name3.includes("form");
+        }
+      }
+    }
+  };
 
   var isFormActionButton = function isFormActionButton(node) {
     return matchesAny([BUTTON_NODE_PATTERN, SUBMIT_BUTTON_PATTERN, CANCEL_BUTTON_PATTERN], node);
@@ -11719,6 +11781,17 @@
       }
     }, node.parent);
   };
+  var traverseParentsAndCheckFormType = function traverseParentsAndCheckFormType(node) {
+    var current = node.parent;
+    while (current) {
+      if (neetoCist.matches(HTML_FORM_ELEMENT_PATTERN, current)) return true;
+      current = current.parent;
+    }
+    return false;
+  };
+  var isInsideHtmlForm = function isInsideHtmlForm(node) {
+    return traverseParentsAndCheckFormType(node);
+  };
   var getAdjacentActionNode = function getAdjacentActionNode(node) {
     var _node$parent, _node$parent$parent, _filterBy2, _findIndexBy2;
     var isSucceedingNode = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
@@ -11753,7 +11826,9 @@
     create: function create(context) {
       return {
         JSXElement: function JSXElement(node) {
-          if (!isFormSubmitButton(node) || isAlternateNode(node)) return;
+          if (!isFormSubmitButton(node) || isAlternateNode(node) || isInsideHtmlForm(node)) {
+            return;
+          }
           var succeedingButton = getAdjacentActionNode(node, true);
           var precedingButton = getAdjacentActionNode(node);
           var start = node.loc.start;
@@ -13121,6 +13196,7 @@
 
   var index = {
     rules: {
+      "switch-children-must-be-route-or-redirect": switchChildrenMustBeRouteOrRedirect,
       "use-dayjs-from-neeto-commons-fronted": useDayjsFromNeetoCommonsFronted,
       "use-neetoui-action-block-in-formik-forms": useNeetouiActionBlockInFormikForms,
       "no-unnecessary-classnames": noUnnecessaryClassnames,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/eslint-plugin-neeto",
-  "version": "1.7.2",
+  "version": "1.7.4",
   "main": "dist/index.js",
   "license": "UNLICENSED",
   "scripts": {
@@ -38,7 +38,7 @@
     "@babel/preset-typescript": "^7.18.6",
     "@babel/runtime": "^7.19.0",
     "@bigbinary/babel-preset-neeto": "^1.0.3",
-    "@bigbinary/eslint-plugin-neeto": "^1.6.2",
+    "@bigbinary/eslint-plugin-neeto": "^1.7.2",
     "@bigbinary/neeto-cist": "^1.0.3",
     "@bigbinary/neeto-commons-frontend": "^4.13.42",
     "@rollup/plugin-alias": "^3.1.9",