@bigbinary/eslint-plugin-neeto 1.4.0 → 1.5.1

package/README.md

@@ -134,6 +134,7 @@ of the issues identified in JavaScript code.
 - [use-neetoui-classes](./docs/src/rules/use-neetoui-classes.md)
 - [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)
 
 ## Overriding rules
 

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-neetoui-action-block-in-formik-forms": "warn",
     "@bigbinary/neeto/no-unnecessary-classnames": "error",
     "@bigbinary/neeto/no-snake-case-destructuring-for-use-query-params-and-get-query-params": "warn",
     "@bigbinary/neeto/no-local-storage": "error",
@@ -588,6 +589,7 @@
   var USE_SHOW_THUMBS_UP_TOASTR_FUNCTION = "Use 'showThumbsUpToastr' function from '@bigbinary/neeto-commons-frontend/utils' for displaying thumbs up toast message.";
   var NO_UNNECESSARY_CLASSNAMES = "classnames usage is unnecessary";
   var USESTATE_DECLARATIONS_SHOULD_HAVE_INITIAL_VALUE = '"useState" declarations should have an initial value.';
+  var USE_NEETOUI_ACTION_BLOCK_IN_FORMIK_FORMS = 'Prefer using neetoui "ActionBlock" instead of "Button" for consistent behavior and appearance.';
 
   var PACKAGES_TO_CHECK = ["@bigbinary/neeto-molecules", "@bigbinary/neetoui", "@bigbinary/neeto-commons-frontend"];
 
@@ -2094,6 +2096,15 @@
 
   var _require = require("prettier"),
     resolveConfig = _require.resolveConfig;
+  var getPrettierConfig = function getPrettierConfig(fileName) {
+    var options = {
+      useCache: true,
+      editorconfig: true
+    };
+    if (resolveConfig.sync) return resolveConfig.sync(fileName, options);
+    var resolveConfigSync = require("synckit").createSyncFn(require.resolve("./resolveConfigWorker.js"));
+    return resolveConfigSync(fileName, options);
+  };
   var ensureCompactObjects = {
     meta: {
       type: "problem",
@@ -2104,9 +2115,9 @@
       fixable: "whitespace"
     },
     create: function create(context) {
+      var prettierConfig = getPrettierConfig(context.getFilename());
       return {
         ObjectExpression: function ObjectExpression(node) {
-          var _resolveConfig$sync;
           if (isExcludedFile(EXCLUDED_FILES, context.getFilename())) return;
           if (!neetoCist.matches(OBJECT_EXPRESSION_PATTERN$1, node)) return;
           var sourceCode = context.getSourceCode();
@@ -2122,10 +2133,7 @@
           if (/\r|\n/.test(_fix)) return;
           var openingBraceColumn = node.loc.start.column;
           var closingBraceColumn = node.loc.end.column;
-          var printWidth = ((_resolveConfig$sync = resolveConfig.sync(context.getFilename(), {
-            useCache: true,
-            editorconfig: true
-          })) === null || _resolveConfig$sync === void 0 ? void 0 : _resolveConfig$sync.printWidth) || 80;
+          var printWidth = (prettierConfig === null || prettierConfig === void 0 ? void 0 : prettierConfig.printWidth) || 80;
           var countOfTokensAfterClosingBrace = sourceCode.lines[closingBraceLine - 1].slice(closingBraceColumn).length;
           var resultLength = openingBraceColumn + _fix.length + countOfTokensAfterClosingBrace;
           if (resultLength > printWidth - 10) return;
@@ -9332,6 +9340,130 @@
     }
   };
 
+  var CANCEL_BUTTON_STYLES = ["secondary", "text"];
+  var SUBMIT_BUTTON_PATTERN = {
+    type: TYPES.JSX_ELEMENT,
+    openingElement: {
+      name: {
+        name: function name(_name) {
+          var _name$toLowerCase;
+          return _name === null || _name === void 0 ? void 0 : (_name$toLowerCase = _name.toLowerCase) === null || _name$toLowerCase === void 0 ? void 0 : _name$toLowerCase.call(_name).includes("button");
+        }
+      },
+      attributes: neetoCist.existsBy({
+        name: {
+          name: "type"
+        },
+        value: {
+          value: "submit"
+        }
+      })
+    }
+  };
+  var CANCEL_BUTTON_PATTERN = {
+    type: TYPES.JSX_ELEMENT,
+    openingElement: {
+      name: {
+        name: function name(_name2) {
+          var _name2$toLowerCase;
+          return _name2 === null || _name2 === void 0 ? void 0 : (_name2$toLowerCase = _name2.toLowerCase) === null || _name2$toLowerCase === void 0 ? void 0 : _name2$toLowerCase.call(_name2).includes("button");
+        }
+      },
+      attributes: neetoCist.existsBy({
+        name: {
+          name: "style"
+        },
+        value: {
+          value: function value(_value) {
+            return CANCEL_BUTTON_STYLES.includes(_value);
+          }
+        }
+      })
+    }
+  };
+  var BUTTON_NODE_PATTERN = {
+    type: TYPES.JSX_EXPRESSION_CONTAINER,
+    expression: matchesAny([{
+      type: TYPES.LOGICAL_EXPRESSION,
+      right: matchesAny([SUBMIT_BUTTON_PATTERN, CANCEL_BUTTON_PATTERN])
+    }, {
+      type: TYPES.CONDITIONAL_EXPRESSION,
+      consequent: matchesAny([SUBMIT_BUTTON_PATTERN, CANCEL_BUTTON_PATTERN])
+    }])
+  };
+  var CONDITIONAL_NODE_TYPES = [TYPES.LOGICAL_EXPRESSION, TYPES.CONDITIONAL_EXPRESSION];
+  var NODE_TYPES = [TYPES.JSX_ELEMENT, TYPES.JSX_EXPRESSION_CONTAINER];
+
+  var isFormActionButton = function isFormActionButton(node) {
+    return matchesAny([BUTTON_NODE_PATTERN, SUBMIT_BUTTON_PATTERN, CANCEL_BUTTON_PATTERN], node);
+  };
+  var isFormSubmitButton = function isFormSubmitButton(node) {
+    return neetoCist.matches(SUBMIT_BUTTON_PATTERN, node);
+  };
+  var isAlternateNode = function isAlternateNode(node) {
+    return neetoCist.matches({
+      alternate: {
+        loc: {
+          start: {
+            line: node.loc.start.line
+          }
+        }
+      }
+    }, node.parent);
+  };
+  var getAdjacentActionNode = function getAdjacentActionNode(node) {
+    var _node$parent, _node$parent$parent, _filterBy2, _findIndexBy2;
+    var isSucceedingNode = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+    var parentNode = CONDITIONAL_NODE_TYPES.includes(node.parent.type) ? (_node$parent = node.parent) === null || _node$parent === void 0 ? void 0 : (_node$parent$parent = _node$parent.parent) === null || _node$parent$parent === void 0 ? void 0 : _node$parent$parent.parent : node.parent;
+    if (neetoCist.isNotPresent(parentNode)) return null;
+    var jsxElementsInCurrentContainer = (_filterBy2 = neetoCist._filterBy({
+      type: function type(_type) {
+        return NODE_TYPES.includes(_type);
+      }
+    }, parentNode.children)) !== null && _filterBy2 !== void 0 ? _filterBy2 : [];
+    var nodeStartLineNumber = CONDITIONAL_NODE_TYPES.includes(node.parent.type) ? node.parent.loc.start.line : node.loc.start.line;
+    var currentNodeIndex = (_findIndexBy2 = neetoCist._findIndexBy({
+      loc: {
+        start: {
+          line: nodeStartLineNumber
+        }
+      }
+    }, jsxElementsInCurrentContainer)) !== null && _findIndexBy2 !== void 0 ? _findIndexBy2 : -1;
+    var adjacentNodeIndex = isSucceedingNode ? currentNodeIndex + 1 : currentNodeIndex - 1;
+    var adjacentNode = jsxElementsInCurrentContainer[adjacentNodeIndex];
+    return isFormActionButton(adjacentNode) ? adjacentNode : null;
+  };
+
+  var useNeetouiActionBlockInFormikForms = {
+    meta: {
+      type: "suggestion",
+      docs: {
+        url: "https://github.com/bigbinary/eslint-plugin-neeto/blob/main/docs/src/rules/use-neetoui-action-block-in-formik-forms.md",
+        description: "Enforces the usage of neetoui `ActionBlock` component in Formik forms instead of custom buttons for submit and cancel actions."
+      }
+    },
+    create: function create(context) {
+      return {
+        JSXElement: function JSXElement(node) {
+          if (!isFormSubmitButton(node) || isAlternateNode(node)) return;
+          var succeedingButton = getAdjacentActionNode(node, true);
+          var precedingButton = getAdjacentActionNode(node);
+          var start = node.loc.start;
+          var end = node.loc.end;
+          if (neetoCist.isPresent(precedingButton)) start = precedingButton.loc.start;
+          if (neetoCist.isPresent(succeedingButton)) end = succeedingButton.loc.end;
+          context.report({
+            loc: {
+              start: start,
+              end: end
+            },
+            message: USE_NEETOUI_ACTION_BLOCK_IN_FORMIK_FORMS
+          });
+        }
+      };
+    }
+  };
+
   var COLORS = ["black", "white", "gray", "red", "yellow", "green", "blue", "indigo", "purple", "pink"];
   var SIZES = ["none", "sm", "md", "lg", "xl", "2xl", "3xl", "full"];
   var BORDER_COLOR_PATTERNS = COLORS.map(function (color) {
@@ -10614,6 +10746,7 @@
 
   var index = {
     rules: {
+      "use-neetoui-action-block-in-formik-forms": useNeetouiActionBlockInFormikForms,
       "no-unnecessary-classnames": noUnnecessaryClassnames,
       "no-snake-case-destructuring-for-use-query-params-and-get-query-params": noSnakeCaseDestructuringForUseQueryParamsAndGetQueryParams,
       "no-local-storage": noLocalStorage,

package/dist/resolveConfigWorker.js

@@ -0,0 +1,8 @@
+const { runAsWorker } = require("synckit");
+
+runAsWorker(async (path, options) => {
+  const prettier = await import("prettier");
+  const config = await prettier.resolveConfig(path, options);
+
+  return config;
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/eslint-plugin-neeto",
-  "version": "1.4.0",
+  "version": "1.5.1",
   "main": "dist/index.js",
   "license": "UNLICENSED",
   "scripts": {
@@ -18,7 +18,8 @@
     ]
   },
   "files": [
-    "dist/index.js"
+    "dist/index.js",
+    "dist/resolveConfigWorker.js"
   ],
   "engines": {
     "node": ">=18.12",
@@ -76,7 +77,9 @@
     "rollup": "^2.75.7",
     "rollup-plugin-analyzer": "^4.0.0",
     "rollup-plugin-cleaner": "^1.0.0",
-    "rollup-plugin-peer-deps-external": "^2.2.4"
+    "rollup-plugin-copy": "^3.5.0",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "synckit": "^0.9.0"
   },
   "peerDependencies": {
     "@bigbinary/neeto-cist": "latest",