@bigbinary/eslint-plugin-neeto 1.1.24 → 1.1.26

package/README.md

@@ -46,7 +46,8 @@ module.exports = {
 
 ## Exported rules
 
-
+- [use-use-query-client-hook](./docs/src/rules/use-use-query-client-hook.md)
+- [use-early-return](./docs/src/rules/use-early-return.md)
 - [use-classnames-for-dynamic-classes](./docs/src/rules/use-classnames-for-dynamic-classes.md)
 - [use-use-mutation-with-invalidation-hook](./docs/src/rules/use-use-mutation-with-invalidation-hook.md)
 - [no-withT-for-smart-components](./docs/src/rules/no-withT-for-smart-components.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/use-use-query-client-hook": "error",
+    "@bigbinary/neeto/use-early-return": "warn",
     "@bigbinary/neeto/use-classnames-for-dynamic-classes": "error",
     "@bigbinary/neeto/use-use-mutation-with-invalidation-hook": "error",
     "@bigbinary/neeto/no-withT-for-smart-components": "error",
@@ -553,6 +555,8 @@
   var MOVE_SPREAD_ATTRIBUTES_TO_TOP = "Move spread attribute to top";
   var USE_USE_MUTATION_WITH_INVALIDATION = "Use useMutationWithInvalidation from 'neetocommons/react-utils'";
   var USE_CLASSNAMES_PACKAGE = "Use classnames package for dynamic classes";
+  var USE_USE_QUERY_CLIENT_HOOK = "Use 'useQueryClient' hook from 'react-query'";
+  var USE_EARLY_RETURN = "Use early return to avoid nested statement";
 
   var PACKAGES_TO_CHECK = ["@bigbinary/neeto-molecules", "@bigbinary/neetoui", "@bigbinary/neeto-commons-frontend"];
 
@@ -6001,7 +6005,7 @@
   var BREAK_STATEMENT_PATTERN = {
     type: TYPES.BREAK_STATEMENT
   };
-  var RETURN_STATEMENT_PATTERN = {
+  var RETURN_STATEMENT_PATTERN$1 = {
     type: TYPES.RETURN_STATEMENT
   };
   var ARRAY_LENGTH_TEST_PATTERN = {
@@ -6044,7 +6048,7 @@
           var _blockStatement$body = _slicedToArray(blockStatement.body, 2),
             firstStatement = _blockStatement$body[0],
             secondStatement = _blockStatement$body[1];
-          if (!(pure.matches(USE_TRANSLATION_HOOK_PATTERN, firstStatement) && pure.matches(RETURN_STATEMENT_PATTERN, secondStatement))) {
+          if (!(pure.matches(USE_TRANSLATION_HOOK_PATTERN, firstStatement) && pure.matches(RETURN_STATEMENT_PATTERN$1, secondStatement))) {
             return;
           }
           context.report({
@@ -8133,7 +8137,7 @@
   };
 
   var isForLoopReplacable = function isForLoopReplacable(node) {
-    return ramda.not(patternExistsDeep(BREAK_STATEMENT_PATTERN, node.body) || patternExistsDeep(RETURN_STATEMENT_PATTERN, node.body) || patternExistsDeep(CHAR_AT_PATTERN, node.body));
+    return ramda.not(patternExistsDeep(BREAK_STATEMENT_PATTERN, node.body) || patternExistsDeep(RETURN_STATEMENT_PATTERN$1, node.body) || patternExistsDeep(CHAR_AT_PATTERN, node.body));
   };
   var useArrayMethods = {
     meta: {
@@ -8811,6 +8815,69 @@
     }
   };
 
+  var RETURN_STATEMENT_PATTERN = {
+    type: TYPES.RETURN_STATEMENT
+  };
+  var RETURN_BLOCK_PATTERN = {
+    type: TYPES.BLOCK_STATEMENT,
+    body: function body(_body) {
+      return _body.length === 1 && pure.matches(RETURN_STATEMENT_PATTERN, _body[0]);
+    }
+  };
+
+  var useEarlyReturn = {
+    meta: {
+      type: "suggestion",
+      docs: {
+        url: "https://github.com/bigbinary/eslint-plugin-neeto/blob/main/docs/src/rules/use-early-return.md",
+        description: "Use early return to avoid nested statements in a function"
+      },
+      fixable: "code"
+    },
+    create: function create(context) {
+      return {
+        ":matches(FunctionDeclaration, ArrowFunctionExpression) > BlockStatement > IfStatement:first-child": function matchesFunctionDeclarationArrowFunctionExpressionBlockStatementIfStatementFirstChild(node) {
+          // checks if a node is `return` type or `block` with only a `return` type
+          var isReturnBlock = ramda.either(pure.matches(RETURN_STATEMENT_PATTERN), pure.matches(RETURN_BLOCK_PATTERN));
+          var ensurePunctuation = function ensurePunctuation(text) {
+            return text.endsWith(";") ? text : "".concat(text, ";");
+          };
+          if (
+          // ignore if:
+          node.parent.body.length > 1 ||
+          // function includes other statements.
+          node.consequent.type !== TYPES.BLOCK_STATEMENT ||
+          // avoid inline `if` statement.
+          isReturnBlock(node.consequent) ||
+          // `if` block only has return statement.
+          node.alternate && !isReturnBlock(node.alternate) ||
+          // `else` block has statements other than return.
+          node.alternate && node.alternate.type === TYPES.IF_STATEMENT // nested if-else ladder
+          ) {
+            return;
+          }
+          var fix = function fix(fixer) {
+            var condition = context.getSourceCode().getText(node.test);
+            var consequent = context.getSourceCode().getText(node.consequent).replace(/^\{|\}$/g, "");
+            var alternate = "return;";
+            if (node.alternate && isReturnBlock(node.alternate)) {
+              alternate = context.getSourceCode().getText(node.alternate);
+              if (node.alternate.type === TYPES.RETURN_STATEMENT) {
+                alternate = ensurePunctuation(alternate);
+              }
+            }
+            return [fixer.insertTextBefore(node, "if(!(".concat(condition, ")) ").concat(alternate)), fixer.replaceText(node, consequent)];
+          };
+          context.report({
+            node: node,
+            message: USE_EARLY_RETURN,
+            fix: fix
+          });
+        }
+      };
+    }
+  };
+
   const defaultOpts$2 = {
       xml: false,
       decodeEntities: true,
@@ -26665,6 +26732,108 @@
     }
   };
 
+  // import queryClient from "..";
+  var QUERY_CLIENT_IMPORT_PATTERN = {
+    type: TYPES.IMPORT_DECLARATION,
+    specifiers: [{
+      type: TYPES.IMPORT_DEFAULT_SPECIFIER,
+      local: {
+        type: TYPES.IDENTIFIER,
+        name: "queryClient"
+      }
+    }]
+  };
+
+  // import { useQueryClient } from "react-query";
+  var USE_QUERY_CLIENT_IMPORT_PATTERN = {
+    type: TYPES.IMPORT_DECLARATION,
+    source: {
+      type: TYPES.LITERAL,
+      value: "react-query"
+    },
+    specifiers: pure.existsBy({
+      type: TYPES.IMPORT_SPECIFIER,
+      local: {
+        type: TYPES.IDENTIFIER,
+        name: "useQueryClient"
+      }
+    })
+  };
+
+  // import {...} from "react-query";
+  var REACT_QUERY_IMPORT_PATTERN = {
+    type: TYPES.IMPORT_DECLARATION,
+    source: {
+      type: TYPES.LITERAL,
+      value: "react-query"
+    },
+    specifiers: [{
+      type: TYPES.IMPORT_SPECIFIER
+    }]
+  };
+
+  var getQueryClientInitializationFix = function getQueryClientInitializationFix(context, fixer, body) {
+    if (body.type === TYPES.BLOCK_STATEMENT) {
+      var indentLevel = context.getSourceCode().getFirstToken(body.body[0]).loc.start.column;
+      return fixer.insertTextBefore(body.body[0], "const queryClient = useQueryClient();\n".concat(" ".repeat(indentLevel)));
+    }
+    return fixer.replaceText(body, "{ const queryClient = useQueryClient(); return (".concat(context.getSourceCode().getText(body), ") }"));
+  };
+
+  var useUseQueryClientHook = {
+    meta: {
+      type: "problem",
+      docs: {
+        url: "https://github.com/bigbinary/eslint-plugin-neeto/blob/main/docs/src/rules/use-use-query-client-hook.md",
+        description: "Enforce use of useQueryClient hook instead of direct queryClient import"
+      },
+      fixable: "code"
+    },
+    create: function create(context) {
+      return {
+        VariableDeclarator: function VariableDeclarator(node) {
+          var _node$parent, _findBy2;
+          if (((_node$parent = node.parent) === null || _node$parent === void 0 ? void 0 : _node$parent.parent.type) !== TYPES.PROGRAM) return;
+          var text = context.getSourceCode().getText(node);
+          if (!text.includes("queryClient.") || text.includes("const queryClient = useQueryClient();")) {
+            return;
+          }
+          var body = node.init.body || ((_findBy2 = pure._findBy({
+            type: TYPES.ARROW_FUNCTION_EXPRESSION
+          }, node.init.arguments)) === null || _findBy2 === void 0 ? void 0 : _findBy2.body);
+          var allImports = getAllImports(node);
+          var queryClientImport = pure.findBy(QUERY_CLIENT_IMPORT_PATTERN, allImports);
+          if (!queryClientImport || !body) return;
+          if (!(/^[A-Z]/.test(node.id.name) || node.id.name.startsWith("use"))) {
+            context.report({
+              node: queryClientImport,
+              message: USE_USE_QUERY_CLIENT_HOOK
+            });
+            return;
+          }
+          context.report({
+            node: queryClientImport,
+            message: USE_USE_QUERY_CLIENT_HOOK,
+            fix: function fix(fixer) {
+              var initializeQueryClient = getQueryClientInitializationFix(context, fixer, body);
+              var importExists = pure.existsBy(USE_QUERY_CLIENT_IMPORT_PATTERN, allImports);
+              if (!importExists) {
+                var addImport = addFunctionImport({
+                  context: context,
+                  fixer: fixer,
+                  functions: ["useQueryClient"],
+                  importPattern: REACT_QUERY_IMPORT_PATTERN
+                });
+                return [initializeQueryClient, addImport];
+              }
+              return initializeQueryClient;
+            }
+          });
+        }
+      };
+    }
+  };
+
   var useWebpackAlias = {
     meta: {
       type: "suggestion",
@@ -27248,6 +27417,8 @@
 
   var index = {
     rules: {
+      "use-use-query-client-hook": useUseQueryClientHook,
+      "use-early-return": useEarlyReturn,
       "use-classnames-for-dynamic-classes": useClassnamesForDynamicClasses,
       "use-use-mutation-with-invalidation-hook": useUseMutationWithInvalidationHook,
       "no-withT-for-smart-components": noWithTForSmartComponents,

package/package.json

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