@bigbinary/eslint-plugin-neeto 1.7.5 → 1.8.0

package/README.md

@@ -140,6 +140,7 @@ of the issues identified in JavaScript code.
 - [use-permissions-prop-in-private-route](./docs/src/rules/use-permissions-prop-in-private-route.md)
 - [use-webpack-alias](./docs/src/rules/use-webpack-alias.md)
 - [use-neetoui-action-block-in-formik-forms](./docs/src/rules/use-neetoui-action-block-in-formik-forms.md)
+- [prefer-radio-buttons-for-few-options](./docs/src/rules/prefer-radio-buttons-for-few-options.md)
 
 ## Overriding rules
 

package/dist/index.js

@@ -38,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/prefer-radio-buttons-for-few-options": "warn",
     "@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",
@@ -330,7 +331,7 @@
   }
 
   var name = "@bigbinary/eslint-plugin-neeto";
-  var version = "1.7.4";
+  var version = "1.7.6";
   var main = "dist/index.js";
   var license = "UNLICENSED";
   var scripts = {
@@ -726,8 +727,23 @@
   var helpUrlConstantNamingConvention = function helpUrlConstantNamingConvention(filename) {
     return "All exported constants in ".concat(filename, " must follow the HELP_..._URL naming convention.");
   };
+  var baseUrlShouldBeInStandardFormat = function baseUrlShouldBeInStandardFormat(filename) {
+    return "All exported base URLS in ".concat(filename, " must be in the standard format help.neeto<product>.com.");
+  };
   var helpUrlInvalidType = function helpUrlInvalidType(filename) {
-    return "Help URL constant must be a template literal string or assigned from another help URL constant. Objects and other types are not allowed in ".concat(filename, ".");
+    return "Help URL constant must be a template literal string, assigned from another help URL constant or a help base URL. Objects and other types are not allowed in ".concat(filename, ".");
+  };
+  var helpUrlOtherNeetoProductConstantNamingConvention = function helpUrlOtherNeetoProductConstantNamingConvention(_ref2) {
+    var filename = _ref2.filename,
+      constantName = _ref2.constantName,
+      suggestedConstantName = _ref2.suggestedConstantName;
+    return "All constants that export help URLs for other neeto products in ".concat(filename, " must follow the HELP_NEETO..._BASE_URL naming convention. Replace '").concat(constantName, "' with '").concat(suggestedConstantName, "'.");
+  };
+  var helpUrlOtherNeetoProductConstantShouldMatchHelpUrl = function helpUrlOtherNeetoProductConstantShouldMatchHelpUrl(_ref3) {
+    var filename = _ref3.filename,
+      constantName = _ref3.constantName,
+      suggestedConstantName = _ref3.suggestedConstantName;
+    return "All constants that export help URLs for other neeto products in ".concat(filename, " must match the help URL. Replace '").concat(constantName, "' with '").concat(suggestedConstantName, "'.");
   };
   var danglingHelpUrlConstant = function danglingHelpUrlConstant(constName, filename) {
     return "Help URL constant '".concat(constName, "' should be defined in '").concat(filename, "'.");
@@ -738,6 +754,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 PREFER_RADIO_BUTTONS_FOR_FEW_OPTIONS = "Consider using Radio buttons instead of Dropdown/Select when there are fewer than 4 options.";
 
   var PACKAGES_TO_CHECK = ["@bigbinary/neeto-molecules", "@bigbinary/neetoui", "@bigbinary/neeto-commons-frontend"];
 
@@ -9159,6 +9176,144 @@
     }
   };
 
+  var MIN_OPTIONS_THRESHOLD = 4;
+  var DROPDOWN_COMPONENT_NAMES = ["Dropdown", "Select", "DropdownMenu", "SelectInput", "MultiSelect", "Menu"];
+  var OPTION_ELEMENT_NAMES = ["option", "Option", "MenuItem", "MenuItemButton"];
+  var DROPDOWN_COMPONENT_PATTERN = {
+    type: TYPES.JSX_ELEMENT,
+    openingElement: {
+      type: TYPES.JSX_OPENING_ELEMENT,
+      name: {
+        type: TYPES.JSX_IDENTIFIER,
+        name: ramda.includes(ramda.__, DROPDOWN_COMPONENT_NAMES)
+      }
+    }
+  };
+  var OPTION_ELEMENT_PATTERN = {
+    type: TYPES.JSX_ELEMENT,
+    openingElement: {
+      type: TYPES.JSX_OPENING_ELEMENT,
+      name: {
+        type: TYPES.JSX_IDENTIFIER,
+        name: ramda.includes(ramda.__, OPTION_ELEMENT_NAMES)
+      }
+    }
+  };
+  var OPTIONS_ARRAY_PATTERN = {
+    type: TYPES.JSX_ATTRIBUTE,
+    name: {
+      type: TYPES.JSX_IDENTIFIER,
+      name: "options"
+    },
+    value: {
+      type: TYPES.JSX_EXPRESSION_CONTAINER
+    }
+  };
+  var SPREAD_ATTRIBUTE_PATTERN = {
+    type: TYPES.JSX_SPREAD_ATTRIBUTE,
+    argument: {
+      type: TYPES.OBJECT_EXPRESSION
+    }
+  };
+  var SPREAD_OPTION_PROPERTY_PATTERN = {
+    type: TYPES.PROPERTY,
+    key: {
+      type: TYPES.IDENTIFIER,
+      name: "options"
+    }
+  };
+
+  var isImportedVariable = function isImportedVariable(node, context) {
+    if (node.type !== TYPES.IDENTIFIER) return false;
+    var scope = context.sourceCode.getScope(node);
+    var variable = scope.set.get(node.name);
+    if (!variable || ramda.isEmpty(variable.defs)) return false;
+    var def = variable.defs[0];
+    return def.type === "ImportBinding";
+  };
+  var resolveVariableReference = function resolveVariableReference(node, context) {
+    var _def$node;
+    if (node.type !== TYPES.IDENTIFIER) return null;
+    var scope = context.sourceCode.getScope(node);
+    var variable = scope.set.get(node.name);
+    if (!variable || ramda.isEmpty(variable.defs)) return null;
+    var def = variable.defs[0];
+    return ((_def$node = def.node) === null || _def$node === void 0 ? void 0 : _def$node.init) || null;
+  };
+  var countArrayElements = function countArrayElements(node, context) {
+    if (node.type === TYPES.ARRAY_EXPRESSION) {
+      return node.elements ? node.elements.length : 0;
+    }
+    if (node.type === TYPES.IDENTIFIER) {
+      if (isImportedVariable(node, context)) return -1;
+      var resolvedNode = resolveVariableReference(node, context);
+      if (resolvedNode) {
+        return countArrayElements(resolvedNode, context);
+      }
+    }
+    return 0;
+  };
+  var countOptions = function countOptions(node, context) {
+    var _node$openingElement, _optionsAttribute$val;
+    var optionCount = 0;
+
+    // Count direct option children
+    if (node.children) {
+      var optionElements = node.children.filter(function (child) {
+        return neetoCist.matches(OPTION_ELEMENT_PATTERN, child);
+      });
+      optionCount += optionElements.length;
+    }
+    var attributes = node === null || node === void 0 ? void 0 : (_node$openingElement = node.openingElement) === null || _node$openingElement === void 0 ? void 0 : _node$openingElement.attributes;
+    if (!attributes) return optionCount;
+
+    // Count options from props passed to the component
+    var optionsAttribute = ramda.find(neetoCist.matches(OPTIONS_ARRAY_PATTERN), attributes);
+    var expression = optionsAttribute === null || optionsAttribute === void 0 ? void 0 : (_optionsAttribute$val = optionsAttribute.value) === null || _optionsAttribute$val === void 0 ? void 0 : _optionsAttribute$val.expression;
+    if (expression) {
+      var elementsCount = countArrayElements(expression, context);
+      optionCount += elementsCount;
+    }
+
+    // Count options from spread props eg: <Component {...{options}} />
+    var spreadAttributes = attributes.filter(function (attribute) {
+      return neetoCist.matches(SPREAD_ATTRIBUTE_PATTERN, attribute);
+    });
+    spreadAttributes.forEach(function (attribute) {
+      if (!attribute.argument) return;
+      if (!(attribute.argument.type === TYPES.OBJECT_EXPRESSION)) return;
+      var optionsProperty = ramda.find(neetoCist.matches(SPREAD_OPTION_PROPERTY_PATTERN), attribute.argument.properties);
+      var optionsPropertyValue = optionsProperty === null || optionsProperty === void 0 ? void 0 : optionsProperty.value;
+      if (!optionsPropertyValue) return;
+      var elementsCount = countArrayElements(optionsPropertyValue, context);
+      optionCount += elementsCount;
+    });
+    return optionCount;
+  };
+  var preferRadioButtonsForFewOptions = {
+    meta: {
+      type: "warn",
+      docs: {
+        url: "https://github.com/bigbinary/eslint-plugin-neeto/blob/main/docs/src/rules/prefer-radio-buttons-for-few-options.md",
+        description: PREFER_RADIO_BUTTONS_FOR_FEW_OPTIONS
+      }
+    },
+    create: function create(context) {
+      return {
+        JSXElement: function JSXElement(node) {
+          if (!neetoCist.matches(DROPDOWN_COMPONENT_PATTERN, node)) return;
+          var optionCount = countOptions(node, context);
+          if (optionCount > 0 && optionCount < MIN_OPTIONS_THRESHOLD) {
+            context.report({
+              node: node,
+              message: PREFER_RADIO_BUTTONS_FOR_FEW_OPTIONS
+            });
+          }
+        }
+      };
+    }
+  };
+
   var NEETO_PACKAGES = ["@bigbinary/neetoui", "@bigbinary/neeto-icons"];
 
   var importedFromNeeto = function importedFromNeeto(context, node) {
@@ -10592,26 +10747,37 @@
       return HELP_URL_CONSTANT_PATTERN.test(_name2);
     }
   };
+  var VALID_HELP_URL_BASE_PATTERN = {
+    type: TYPES.LITERAL,
+    value: function value(_value) {
+      return typeof _value === "string" && HELP_URL_BASE_REGEX.test(_value);
+    }
+  };
   var HELP_URLS_FILENAME = "helpUrls.js";
   var HELP_URL_CONSTANT_PATTERN = /^HELP_.*_URL$/;
   var HELP_DOCS_BASE_URL_CONSTANT_NAME = "HELP_DOCS_BASE_URL";
   var ARTICLE_LINK_REGEX = /\/articles\//;
   // Regex matches help.neeto<subdomain>.com
-  var HELP_URL_BASE_REGEX = /help\.neeto[a-z]+\.com/;
+  var HELP_URL_BASE_REGEX = /help\.(neeto[a-z]+)\.com/;
   // Regex for the old/incorrect format: neeto<product>help.neetokb.com
   var OLD_HELP_URL_BASE_REGEX = /neeto[a-z]+help\.neetokb\.com/;
+  // Regex matches HELP_NEETO..._BASE_URL
+  var HELP_URL_OTHER_NEETO_PRODUCT_CONSTANT_REGEX = /^HELP_NEETO.*_BASE_URL$/;
+  var HELP_URL_OTHER_NEETO_PRODUCT_CONSTANT_NAME_TEMPLATE = function HELP_URL_OTHER_NEETO_PRODUCT_CONSTANT_NAME_TEMPLATE(neetoProductName) {
+    return "HELP_".concat(neetoProductName, "_BASE_URL");
+  };
   var BASE_URL_DECLARATOR_PATTERN = {
     id: {
       name: HELP_DOCS_BASE_URL_CONSTANT_NAME
     },
     init: {
       type: TYPES.LITERAL,
-      value: function value(_value) {
-        return typeof _value === "string";
+      value: function value(_value2) {
+        return typeof _value2 === "string";
       }
     }
   };
-  var VALID_HELP_URL_INIT_PATTERN = matchesAny([VALID_TEMPLATE_LITERAL_INIT_PATTERN, VALID_IDENTIFIER_INIT_PATTERN]);
+  var VALID_HELP_URL_INIT_PATTERN = matchesAny([VALID_TEMPLATE_LITERAL_INIT_PATTERN, VALID_IDENTIFIER_INIT_PATTERN, VALID_HELP_URL_BASE_PATTERN]);
   var DANGLING_HELP_URL_DECLARATOR_PATTERN = {
     type: TYPES.VARIABLE_DECLARATOR,
     id: {
@@ -10625,6 +10791,19 @@
     }
   };
 
+  var getNeetoProductNameFromHelpUrl = function getNeetoProductNameFromHelpUrl(helpUrl) {
+    var match = helpUrl.match(HELP_URL_BASE_REGEX);
+    return match ? match[1].toUpperCase() : null;
+  };
+  var getSuggestedHelpUrlOtherNeetoProductConstantName = function getSuggestedHelpUrlOtherNeetoProductConstantName(helpUrl) {
+    var neetoProductName = getNeetoProductNameFromHelpUrl(helpUrl);
+    return HELP_URL_OTHER_NEETO_PRODUCT_CONSTANT_NAME_TEMPLATE(neetoProductName);
+  };
+  var checkIfConstantNameMatchesHelpUrl = function checkIfConstantNameMatchesHelpUrl(constantName, helpUrl) {
+    var neetoProductName = getNeetoProductNameFromHelpUrl(helpUrl);
+    return constantName === HELP_URL_OTHER_NEETO_PRODUCT_CONSTANT_NAME_TEMPLATE(neetoProductName);
+  };
+
   function _createForOfIteratorHelper$1(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray$1(o)) || allowArrayLike) { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
   function _unsupportedIterableToArray$1(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray$1(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray$1(o, minLen); }
   function _arrayLikeToArray$1(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
@@ -10661,9 +10840,68 @@
       });
       return false;
     }
+    if (!neetoCist.matches(VALID_HELP_URL_BASE_PATTERN, declarator.init)) {
+      context.report({
+        node: declarator,
+        message: baseUrlShouldBeInStandardFormat(HELP_URLS_FILENAME)
+      });
+      return false;
+    }
     return true;
   };
 
+  /**
+   * Validates a base help URL constant declaration for other neeto products inside helpUrls.js.
+   * e.g., `export const HELP_NEETOCHAT_BASE_URL = "https://help.neetochat.com";`
+   */
+  var validateOtherNeetoProductConstant = function validateOtherNeetoProductConstant(context, declarator) {
+    var constantName = declarator.id.name;
+    var init = declarator.init;
+
+    // Check 1: Checks that the constant name follows the naming convention (HELP_NEETO..._BASE_URL)
+    if (!HELP_URL_OTHER_NEETO_PRODUCT_CONSTANT_REGEX.test(constantName)) {
+      var suggestedConstantName = getSuggestedHelpUrlOtherNeetoProductConstantName(init.value);
+      context.report({
+        node: declarator,
+        message: helpUrlOtherNeetoProductConstantNamingConvention({
+          filename: HELP_URLS_FILENAME,
+          constantName: constantName,
+          suggestedConstantName: suggestedConstantName
+        }),
+        fix: function fix(fixer) {
+          return fixer.replaceText(declarator.id, suggestedConstantName);
+        }
+      });
+      return;
+    }
+
+    //Check 2: If the constant name matches the help URL, check that the help URL is in the correct format.
+    if (OLD_HELP_URL_BASE_REGEX.test(init.value)) {
+      context.report({
+        node: declarator,
+        message: HELP_URL_INCORRECT_FORMAT
+      });
+      return;
+    }
+
+    // Check 3: Checks that the constant name matches the help URL
+    if (!checkIfConstantNameMatchesHelpUrl(constantName, init.value)) {
+      var _suggestedConstantName = getSuggestedHelpUrlOtherNeetoProductConstantName(init.value);
+      context.report({
+        node: declarator,
+        message: helpUrlOtherNeetoProductConstantShouldMatchHelpUrl({
+          filename: HELP_URLS_FILENAME,
+          constantName: constantName,
+          suggestedConstantName: _suggestedConstantName
+        }),
+        fix: function fix(fixer) {
+          return fixer.replaceText(declarator.id, _suggestedConstantName);
+        }
+      });
+      return;
+    }
+  };
+
   /**
    * Validates a single help URL constant declaration inside helpUrls.js.
    * e.g., `export const HELP_API_KEYS_URL = \`\${HELP_DOCS_BASE_URL}/p/a-d7e4285a\`;`
@@ -10681,7 +10919,7 @@
     }
     var init = declarator.init;
 
-    // Check 2: Must be a valid template literal or identifier assignment.
+    // Check 2: Must be a valid template literal, identifier assignment or help URL base.
     if (!neetoCist.matches(VALID_HELP_URL_INIT_PATTERN, init)) {
       context.report({
         node: declarator,
@@ -10698,8 +10936,14 @@
           node: declarator,
           message: HELP_URL_SHOULD_USE_PERMALINK
         });
+        return;
       }
     }
+
+    //Check 4: If it's a help URL base for other neeto products, validate the constant name.
+    if (init.type === TYPES.LITERAL) {
+      validateOtherNeetoProductConstant(context, declarator);
+    }
   };
 
   /**
@@ -10807,7 +11051,7 @@
         url: "https://github.com/bigbinary/eslint-plugin-neeto/blob/main/docs/src/rules/standardize-help-urls.md",
         description: "Ensure help URLs are standardized and defined in helpUrls.js"
       },
-      fixable: null
+      fixable: "code"
     },
     create: function create(context) {
       var filename = context.getFilename();
@@ -13205,6 +13449,7 @@
 
   var index = {
     rules: {
+      "prefer-radio-buttons-for-few-options": preferRadioButtonsForFewOptions,
       "switch-children-must-be-route-or-redirect": switchChildrenMustBeRouteOrRedirect,
       "use-dayjs-from-neeto-commons-fronted": useDayjsFromNeetoCommonsFronted,
       "use-neetoui-action-block-in-formik-forms": useNeetouiActionBlockInFormikForms,

package/package.json

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