@bigbinary/eslint-plugin-neeto 1.1.37 → 1.1.39

package/README.md

@@ -122,6 +122,7 @@ module.exports = {
 - [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)
+- [jsx-prefer-guard-clause.md](./docs/src/rules/jsx-prefer-guard-clause.md)
 
 ## Other references
 

package/dist/index.js

@@ -162,7 +162,8 @@
     "@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/prefer-function-reference": "warn"
+    "@bigbinary/neeto/prefer-function-reference": "warn",
+    "@bigbinary/neeto/jsx-prefer-guard-clause": "warn"
   };
 
   var recommended = {
@@ -564,6 +565,7 @@
   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 JSX_PREFER_GUARD_CLAUSE = "Prefer adding a guard clause for conditional statements left of JSX statments in the last return statement of the function.";
 
   var PACKAGES_TO_CHECK = ["@bigbinary/neeto-molecules", "@bigbinary/neetoui", "@bigbinary/neeto-commons-frontend"];
 
@@ -1315,7 +1317,7 @@
     }
   };
 
-  var checkAndReport$7 = function checkAndReport(context, node) {
+  var checkAndReport$8 = function checkAndReport(context, node) {
     if (!isInsideApisDirectory(context)) return;
     context.report({
       node: node,
@@ -1333,11 +1335,11 @@
     create: function create(context) {
       return {
         ExportNamedDeclaration: function ExportNamedDeclaration(node) {
-          checkAndReport$7(context, node);
+          checkAndReport$8(context, node);
         },
         ExportDefaultDeclaration: function ExportDefaultDeclaration(node) {
           if (node.declaration.type !== TYPES.OBJECT_EXPRESSION) return;
-          checkAndReport$7(context, node);
+          checkAndReport$8(context, node);
         }
       };
     }
@@ -1439,7 +1441,7 @@
       }
     });
   };
-  var checkAndReport$6 = function checkAndReport(context, node) {
+  var checkAndReport$7 = function checkAndReport(context, node) {
     if (!node.async) return;
     var subsequentAwaits = getIndependentAwaits(node);
     if (subsequentAwaits.length === 0) return;
@@ -1460,15 +1462,15 @@
       return {
         // const sum = (a, b) => a + b;
         ArrowFunctionExpression: function ArrowFunctionExpression(node) {
-          checkAndReport$6(context, node);
+          checkAndReport$7(context, node);
         },
         // const sum = function (a, b) { return a + b };
         FunctionExpression: function FunctionExpression(node) {
-          checkAndReport$6(context, node);
+          checkAndReport$7(context, node);
         },
         // function sum (a, b) { return a + b };
         FunctionDeclaration: function FunctionDeclaration(node) {
-          checkAndReport$6(context, node);
+          checkAndReport$7(context, node);
         }
       };
     }
@@ -3773,6 +3775,49 @@
     }
   };
 
+  var checkAndReport$6 = function checkAndReport(context, node) {
+    var _lastStatement$argume;
+    if (node.body.type !== TYPES.BLOCK_STATEMENT) return;
+    var statements = node.body.body;
+    if (statements.length <= 0) return;
+    var lastStatement = ramda.last(statements);
+    if (lastStatement.type !== TYPES.RETURN_STATEMENT) return;
+    if (lastStatement.argument.type !== TYPES.LOGICAL_EXPRESSION || ((_lastStatement$argume = lastStatement.argument) === null || _lastStatement$argume === void 0 ? void 0 : _lastStatement$argume.operator) !== "&&") {
+      return;
+    }
+    var _lastStatement$argume2 = lastStatement.argument,
+      left = _lastStatement$argume2.left,
+      right = _lastStatement$argume2.right;
+    var isJsxStatement = [TYPES.JSX_ELEMENT, TYPES.JSX_EXPRESSION_CONTAINER, TYPES.JSX_IDENTIFIER, TYPES.JSX_OPENING_ELEMENT].includes(right.type);
+
+    // If it's a logical expression and if the right side arg is JSX
+    // then we can suggest using guard clause
+    if (isJsxStatement) {
+      context.report({
+        node: left,
+        message: JSX_PREFER_GUARD_CLAUSE
+      });
+    }
+  };
+  var jsxPreferGuardClause = {
+    meta: {
+      type: "suggestion",
+      docs: {
+        url: "https://github.com/bigbinary/eslint-plugin-neeto/blob/main/docs/src/rules/jsx-prefer-guard-clause.md",
+        description: "Encourage using a guard clause for the last conditional return statement of a JSX component.",
+        category: "Best Practices",
+        recommended: true
+      }
+    },
+    create: function create(context) {
+      return {
+        ArrowFunctionExpression: function ArrowFunctionExpression(node) {
+          checkAndReport$6(context, node);
+        }
+      };
+    }
+  };
+
   function ownKeys$3(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
   function _objectSpread$3(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys$3(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys$3(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
   var LOCALIZATION_CALL_PATTERNS = [{
@@ -4606,7 +4651,7 @@
     return "It may be possible to shorten this code using ".concat(replacement, " from neetocist");
   };
 
-  var NEETO_COMMONS_UTILS_IMPORT_PATTERNS = ["neetocommons/utils", "@bigbinary/neeto-commons-frontend/utils", "neetomolecules/CopyToClipboardButton", "@bigbinary/neeto-molecules/CopyToClipboardButton"];
+  var NEETO_COMMONS_UTILS_IMPORT_PATTERNS = ["neetocommons/utils", "neetocommons/utils/general", "@bigbinary/neeto-commons-frontend/utils", "@bigbinary/neeto-commons-frontend/utils/general", "neetomolecules/CopyToClipboardButton", "@bigbinary/neeto-molecules/CopyToClipboardButton"];
   var NOT_EQUALS_DEEP_CALL_EXP_PATTERN = {
     type: TYPES.CALL_EXPRESSION,
     callee: {
@@ -8863,6 +8908,8 @@
     }
   };
 
+  var ALLOWED_IMPORTS = ["neetocommons/utils/createSubscription", "neetocommons/utils"];
+
   // createSubscription();
   var CUSTOM_CREATE_SUBSCRIPTION_PATTERN = {
     type: TYPES.CALL_EXPRESSION,
@@ -8943,7 +8990,9 @@
       type: TYPES.IMPORT_DECLARATION,
       source: {
         type: TYPES.LITERAL,
-        value: neetoCist.isNot("neetocommons/utils")
+        value: function value(_value) {
+          return !ramda.includes(_value, ALLOWED_IMPORTS);
+        }
       },
       specifiers: ramda.any(matchesAny([{
         type: TYPES.IMPORT_DEFAULT_SPECIFIER,
@@ -10478,7 +10527,8 @@
       "add-required-peer-dependencies": addRequiredPeerDependencies,
       "use-common-constants": useCommonConstants,
       "move-spread-attributes-to-top-position": moveSpreadAttributesToTopPosition,
-      "prefer-function-reference": preferFunctionReference
+      "prefer-function-reference": preferFunctionReference,
+      "jsx-prefer-guard-clause": jsxPreferGuardClause
     },
     configs: {
       recommended: recommended,

package/package.json

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