@bigbinary/eslint-plugin-neeto 1.1.42 → 1.3.0

package/README.md

@@ -46,6 +46,7 @@ module.exports = {
 
 ## Exported rules
 
+- [no-unnecessary-classnames](./docs/src/rules/no-unnecessary-classnames.md)
 - [no-snake-case-destructuring-for-use-query-params-and-get-query-params](./docs/src/rules/no-snake-case-destructuring-for-use-query-params-and-get-query-params.md)
 - [no-local-storage](./docs/src/rules/no-local-storage.md)
 - [no-lowercase-on-translation](./docs/src/rules/no-lowercase-on-translation.md)
@@ -123,6 +124,7 @@ module.exports = {
 - [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)
+- [use-show-thumbs-up-toastr.md](./docs/src/rules/use-show-thumbs-up-toastr)
 
 ## Other references
 

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/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",
     "@bigbinary/neeto/no-lowercase-on-translation": "warn",
@@ -163,7 +164,8 @@
     "@bigbinary/neeto/use-common-constants": "warn",
     "@bigbinary/neeto/move-spread-attributes-to-top-position": "error",
     "@bigbinary/neeto/prefer-function-reference": "warn",
-    "@bigbinary/neeto/jsx-prefer-guard-clause": "warn"
+    "@bigbinary/neeto/jsx-prefer-guard-clause": "warn",
+    "@bigbinary/neeto/use-show-thumbs-up-toastr": "error"
   };
 
   var recommended = {
@@ -438,6 +440,18 @@
   var NO_OF_LINES_ALLOWED_FOR_MULTIPLE_COMPONENTS_IN_A_FILE = 20;
   var MAX_LINES_FOR_FUNCTIONS_INSIDE_JSX = 4;
 
+  // import { functionName } from neetocommons/utils;
+  var NEETO_COMMONS_UTILS_IMPORT_PATTERN = {
+    type: TYPES.IMPORT_DECLARATION,
+    source: {
+      type: TYPES.LITERAL,
+      value: "neetocommons/utils"
+    },
+    specifiers: [{
+      type: TYPES.IMPORT_SPECIFIER
+    }]
+  };
+
   var ARGUMENT_LIMIT = 3;
   var API_ACTIONS_ARGUMENT_LIMIT = 2;
   var FIXABLE_PARAMETER_TYPES = [TYPES.IDENTIFIER, TYPES.ASSIGNMENT_PATTERN];
@@ -453,10 +467,10 @@
     return "Do not use the package ".concat(packageName);
   };
   var exportedObjectShouldBe = function exportedObjectShouldBe(caseStyle) {
-    return "Exported object should be in ".concat(caseStyle, ". Refer https://www.youtube.com/watch?v=As9BzWsGJfY");
+    return "Exported object should be in ".concat(caseStyle, ". Refer https://youtu.be/uZtRIvo8-ww");
   };
   var filenameShouldBe = function filenameShouldBe(caseStyle) {
-    return "Filename should be in ".concat(caseStyle, ". Refer https://www.youtube.com/watch?v=As9BzWsGJfY");
+    return "Filename should be in ".concat(caseStyle, ". Refer https://youtu.be/uZtRIvo8-ww");
   };
   var moveToConstantsJs = function moveToConstantsJs(constantName) {
     return "Move the constant ".concat(constantName, " to a constants.js file.");
@@ -570,6 +584,8 @@
   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 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 PACKAGES_TO_CHECK = ["@bigbinary/neeto-molecules", "@bigbinary/neetoui", "@bigbinary/neeto-commons-frontend"];
 
@@ -2068,7 +2084,7 @@
     }
   };
 
-  var OBJECT_EXPRESSION_PATTERN = {
+  var OBJECT_EXPRESSION_PATTERN$1 = {
     type: TYPES.OBJECT_EXPRESSION,
     properties: neetoCist.isNotEmpty
   };
@@ -2090,7 +2106,7 @@
         ObjectExpression: function ObjectExpression(node) {
           var _resolveConfig$sync;
           if (isExcludedFile(EXCLUDED_FILES, context.getFilename())) return;
-          if (!neetoCist.matches(OBJECT_EXPRESSION_PATTERN, node)) return;
+          if (!neetoCist.matches(OBJECT_EXPRESSION_PATTERN$1, node)) return;
           var sourceCode = context.getSourceCode();
           var hasComments = neetoCist.isNotEmpty(sourceCode.getCommentsInside(node));
           if (hasComments) return;
@@ -6607,7 +6623,7 @@
   };
 
   var SNAKE_CASE_WITHOUT_SINGLE_WORDS = /^[a-z]+_[a-z0-9_]+$/;
-  var PATTERN = {
+  var PATTERN$1 = {
     id: {
       type: "ObjectPattern",
       properties: ramda.any(neetoCist.matches({
@@ -6647,7 +6663,7 @@
     create: function create(context) {
       return {
         VariableDeclarator: function VariableDeclarator(node) {
-          if (neetoCist.matches(PATTERN, node)) {
+          if (neetoCist.matches(PATTERN$1, node)) {
             context.report({
               node: node,
               message: AVOID_SNAKE_CASE_DESTRUCTURING_USEQUERYPARAMS_OR_GETQUERYPARAMS
@@ -6658,6 +6674,57 @@
     }
   };
 
+  var CLASS_NAME = "className";
+  var CLASS_NAMES = ["classnames", "classNames"];
+  var PATTERN = neetoCist.matches({
+    name: {
+      name: CLASS_NAME
+    },
+    value: {
+      expression: {
+        type: TYPES.CALL_EXPRESSION,
+        callee: {
+          name: matchesAny(CLASS_NAMES)
+        },
+        arguments: _defineProperty({
+          length: 1
+        }, 0, {
+          type: matchesAny([TYPES.LITERAL, TYPES.TEMPLATE_LITERAL])
+        })
+      }
+    }
+  });
+
+  var noUnnecessaryClassnames = {
+    meta: {
+      type: "suggestion",
+      docs: {
+        url: "https://github.com/bigbinary/eslint-plugin-neeto/blob/main/docs/src/rules/no-unnecessary-classnames.md",
+        description: "classnames usage is unnecessary"
+      },
+      fixable: "code"
+    },
+    create: function create(context) {
+      return {
+        JSXAttribute: function JSXAttribute(node) {
+          if (!neetoCist.matches(PATTERN, node)) return;
+          context.report({
+            node: node,
+            message: NO_UNNECESSARY_CLASSNAMES,
+            fix: function fix(fixer) {
+              var singleClass = node.value.expression.arguments[0];
+              var classText = context.getSourceCode().getText(singleClass);
+              if (singleClass.type === TYPES.TEMPLATE_LITERAL) {
+                classText = "{".concat(classText, "}");
+              }
+              return fixer.replaceTextRange([node.range[0], node.range[1]], "className=".concat(classText));
+            }
+          });
+        }
+      };
+    }
+  };
+
   // if (condition) statement;
   var SINGLE_LINE_IF_CONDITION_PATTERN = {
     parent: {
@@ -8979,18 +9046,6 @@
     })
   };
 
-  // import { functionName } from neetocommons/utils;
-  var NEETO_COMMONS_UTILS_IMPORT_PATTERN = {
-    type: TYPES.IMPORT_DECLARATION,
-    source: {
-      type: TYPES.LITERAL,
-      value: "neetocommons/utils"
-    },
-    specifiers: [{
-      type: TYPES.IMPORT_SPECIFIER
-    }]
-  };
-
   var createSubscriptionImportPattern = function createSubscriptionImportPattern(functionName) {
     return {
       type: TYPES.IMPORT_DECLARATION,
@@ -9442,6 +9497,77 @@
     }
   };
 
+  var OBJECT_EXPRESSION_PATTERN = {
+    type: TYPES.OBJECT_EXPRESSION,
+    properties: neetoCist.existsBy({
+      key: {
+        name: "icon"
+      },
+      value: {
+        value: "👍"
+      }
+    })
+  };
+
+  // Toastr.success("", { icon: "👍", className: "w-20" });
+  var TOASTR_SUCCESS_THUMBS_UP_PATTERN = {
+    callee: {
+      object: {
+        name: "Toastr"
+      },
+      property: {
+        name: "success"
+      }
+    },
+    arguments: neetoCist.existsBy(OBJECT_EXPRESSION_PATTERN)
+  };
+
+  // const THUMBS_UP = { icon: "👍", className: "w-20" }
+  var THUMBS_UP_OBJECT_DECLARATION = {
+    id: {
+      type: TYPES.IDENTIFIER,
+      name: "THUMBS_UP"
+    },
+    init: OBJECT_EXPRESSION_PATTERN
+  };
+
+  var useShowThumbsUpToastr = {
+    meta: {
+      type: "problem",
+      docs: {
+        url: "https://github.com/bigbinary/eslint-plugin-neeto/blob/main/docs/src/rules/use-show-thumbs-up-toastr.md",
+        description: "Enforces the use of 'showThumbsUpToastr' function for displaying thumbs up toast messages."
+      },
+      fixable: "code"
+    },
+    create: function create(context) {
+      return {
+        CallExpression: function CallExpression(node) {
+          if (!neetoCist.matches(TOASTR_SUCCESS_THUMBS_UP_PATTERN, node)) return;
+          context.report({
+            node: node,
+            message: USE_SHOW_THUMBS_UP_TOASTR_FUNCTION,
+            fix: function fix(fixer) {
+              var fixerArr = [fixer.replaceText(node, "showThumbsUpToastr()")];
+              var addImport = addFunctionImport({
+                context: context,
+                fixer: fixer,
+                functions: ["showThumbsUpToastr"],
+                importPattern: NEETO_COMMONS_UTILS_IMPORT_PATTERN
+              });
+              if (addImport) fixerArr.push(addImport);
+              return fixerArr;
+            }
+          });
+        },
+        VariableDeclarator: function VariableDeclarator(node) {
+          if (!neetoCist.matches(THUMBS_UP_OBJECT_DECLARATION, node)) return;
+          context.report(node, USE_SHOW_THUMBS_UP_TOASTR_FUNCTION);
+        }
+      };
+    }
+  };
+
   var isSnakeCase = function isSnakeCase(text) {
     return SNAKE_CASE_REGEX.test(text);
   };
@@ -10456,6 +10582,7 @@
 
   var index = {
     rules: {
+      "no-unnecessary-classnames": noUnnecessaryClassnames,
       "no-snake-case-destructuring-for-use-query-params-and-get-query-params": noSnakeCaseDestructuringForUseQueryParamsAndGetQueryParams,
       "no-local-storage": noLocalStorage,
       "no-lowercase-on-translation": noLowercaseOnTranslation,
@@ -10534,7 +10661,8 @@
       "use-common-constants": useCommonConstants,
       "move-spread-attributes-to-top-position": moveSpreadAttributesToTopPosition,
       "prefer-function-reference": preferFunctionReference,
-      "jsx-prefer-guard-clause": jsxPreferGuardClause
+      "jsx-prefer-guard-clause": jsxPreferGuardClause,
+      "use-show-thumbs-up-toastr": useShowThumbsUpToastr
     },
     configs: {
       recommended: recommended,

package/package.json

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