@bigbinary/eslint-plugin-neeto 1.1.24 → 1.1.25

package/README.md

@@ -46,6 +46,7 @@ module.exports = {
 
 ## Exported rules
 
+- [use-use-query-client-hook](./docs/src/rules/use-use-query-client-hook.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)

package/dist/index.js

@@ -42,6 +42,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/use-use-query-client-hook": "error",
     "@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 +554,7 @@
   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 PACKAGES_TO_CHECK = ["@bigbinary/neeto-molecules", "@bigbinary/neetoui", "@bigbinary/neeto-commons-frontend"];
 
@@ -26665,6 +26667,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 +27352,7 @@
 
   var index = {
     rules: {
+      "use-use-query-client-hook": useUseQueryClientHook,
       "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.25",
   "main": "dist/index.js",
   "license": "UNLICENSED",
   "scripts": {