@agilebot/eslint-plugin 0.3.10 → 0.3.12

package/LICENSE

@@ -1,9 +1,9 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 Agilebot, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2024 Agilebot, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/LICENSE.tpl

@@ -1,8 +1,8 @@
-/**
- * @license %(name)s v%(version)s
- *
- * Copyright (c) Agilebot, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
+/**
+ * @license %(name)s v%(version)s
+ *
+ * Copyright (c) Agilebot, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */

package/README.md

@@ -1,9 +1,9 @@
-# @agilebot/eslint-plugin
-
-Agilebot extended ESLint rules. For @agilebot/eslint-config.
-
-### Usage
-
-```bash
-npm install --save-dev eslint @agilebot/eslint-plugin
-```
+# @agilebot/eslint-plugin
+
+Agilebot extended ESLint rules. For @agilebot/eslint-config.
+
+### Usage
+
+```bash
+npm install --save-dev eslint @agilebot/eslint-plugin
+```

package/dist/index.js

@@ -1,11 +1,11 @@
-/**
- * @license @agilebot/eslint-plugin v0.3.10
- *
- * Copyright (c) Agilebot, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
+/**
+ * @license @agilebot/eslint-plugin v0.3.12
+ *
+ * Copyright (c) Agilebot, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
 'use strict';
 
 var eslintUtils = require('@agilebot/eslint-utils');
@@ -72,127 +72,6 @@ var enforceMuiIconAlias = eslintUtils.createESLintRule({
   }
 });
 
-var funcNaming = eslintUtils.createESLintRule({
-  meta: {
-    type: 'problem',
-    docs: {
-      description: 'Enforce function naming convention'
-    },
-    schema: [{
-      type: 'object',
-      properties: {
-        format: {
-          type: 'string',
-          "enum": ['camelCase', 'PascalCase']
-        }
-      }
-    }],
-    messages: {
-      invalidFuncNaming: 'Invalid function naming for non-React component, expected {{format}}',
-      invalidReactFCNaming: 'Invalid naming convention for React functional component, expected PascalCase'
-    }
-  },
-  defaultOptions: [],
-  create(context) {
-    if (!context.options[0]) {
-      throw new Error('Missing options');
-    }
-    const format = context.options[0].format;
-    function validate({
-      node,
-      fnName
-    }) {
-      let isPass;
-      switch (format) {
-        case 'camelCase':
-          if (!eslintUtils.isCamelCase(fnName)) {
-            isPass = false;
-          }
-          break;
-        case 'PascalCase':
-          if (!eslintUtils.isPascalCase(fnName)) {
-            isPass = false;
-          }
-          break;
-      }
-      if (isPass === false) {
-        context.report({
-          node: node,
-          messageId: 'invalidFuncNaming',
-          data: {
-            format
-          }
-        });
-      }
-    }
-    function checkJSXElement(node) {
-      if (!node) {
-        return false;
-      }
-      if (node.type === 'JSXElement' || node.type === 'JSXFragment') {
-        return true;
-      }
-      if (node.type === 'BlockStatement') {
-        for (const statement of node.body) {
-          if (statement.type === 'ReturnStatement') {
-            if (checkJSXElement(statement.argument)) {
-              return true;
-            }
-          } else if (checkJSXElement(statement)) {
-            return true;
-          }
-        }
-      }
-      if (node.type === 'ArrowFunctionExpression' || node.type === 'FunctionExpression') {
-        return checkJSXElement(node.body);
-      }
-      return false;
-    }
-    return {
-      MethodDefinition(node) {
-        if (node.kind === 'method') ;
-      },
-      FunctionDeclaration(node) {
-        if (node.type === 'FunctionDeclaration' && node.id) {
-          const fnName = node.id.name;
-          const isReactComponent = checkJSXElement(node.body);
-          if (!isReactComponent) {
-            validate({
-              node,
-              fnName
-            });
-          }
-        }
-      },
-      VariableDeclarator(node) {
-        if (node.id && node.init && ['FunctionExpression', 'ArrowFunctionExpression'].includes(node.init.type)) {
-          const fnName = node.id.name;
-          let isReactComponent = checkJSXElement(node.init.body);
-          if (node.id.typeAnnotation && node.id.typeAnnotation.typeAnnotation) {
-            const typeAnnotation = node.id.typeAnnotation.typeAnnotation;
-            if (typeAnnotation.type === 'TSTypeReference' && typeAnnotation.typeName.type === 'Identifier') {
-              const typeName = typeAnnotation.typeName.name;
-              const typeNameLast = typeName.split('.').pop();
-              if (['FC', 'FunctionComponent', 'VFC', 'VoidFunctionComponent'].includes(typeNameLast)) {
-                isReactComponent = true;
-              }
-            }
-          }
-          if (!isReactComponent) {
-            validate({
-              node,
-              fnName
-            });
-          }
-        }
-      },
-      Property(node) {
-        if (node.value.type === 'FunctionExpression') ;
-      }
-    };
-  }
-});
-
 function getSetting(context, name) {
   return context.settings["agilebot/".concat(name)];
 }
@@ -2679,10 +2558,204 @@ var tssUnusedClasses = eslintUtils.createESLintRule({
   }
 });
 
+const reactGlobalFuncs = new Set(['createContext', 'forwardRef', 'lazy', 'memo', 'combineProviders']);
+const reactFCTypes = new Set(['FC', 'FunctionComponent', 'VFC', 'VoidFunctionComponent']);
+const otherTypes = new Set(['StoryObj', 'StoryFn']);
+const defaultExcludes = ['^(__dirname|__filename)$', '(.*)Event$'];
+var varNaming = eslintUtils.createESLintRule({
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'Enforce variable and function naming convention',
+      recommended: 'recommended'
+    },
+    schema: [{
+      type: 'object',
+      properties: {
+        funcFormat: {
+          type: 'array',
+          items: {
+            "enum": ['camelCase', 'PascalCase', 'UPPER_CASE']
+          }
+        },
+        varFormat: {
+          type: 'array',
+          items: {
+            "enum": ['camelCase', 'PascalCase', 'UPPER_CASE']
+          }
+        },
+        exclude: {
+          type: 'array',
+          items: {
+            type: 'string'
+          }
+        }
+      }
+    }],
+    messages: {
+      invalidFuncNaming: 'Invalid function naming for non-React component, expected {{formats}}',
+      invalidReactFCNaming: 'Invalid naming convention for React functional component, expected PascalCase',
+      invalidVarNaming: 'Invalid variable naming, expected {{formats}}'
+    }
+  },
+  defaultOptions: [],
+  create(context) {
+    if (!context.options[0]) {
+      context.options[0] = {};
+    }
+    const funcFormat = context.options[0].funcFormat || ['camelCase'];
+    const varFormat = context.options[0].varFormat || ['camelCase', 'UPPER_CASE'];
+    let exclude = context.options[0].exclude || [];
+    exclude = [...defaultExcludes, ...exclude];
+    function validate(type, {
+      node,
+      name
+    }) {
+      let isPass = false;
+      let formats;
+      let messageId;
+      switch (type) {
+        case 'func':
+          formats = funcFormat;
+          messageId = 'invalidFuncNaming';
+          break;
+        case 'var':
+          formats = varFormat;
+          messageId = 'invalidVarNaming';
+          break;
+      }
+      for (const format of formats) {
+        switch (format) {
+          case 'camelCase':
+            if (eslintUtils.isCamelCase(name)) {
+              isPass = true;
+            }
+            break;
+          case 'PascalCase':
+            if (eslintUtils.isPascalCase(name)) {
+              isPass = true;
+            }
+            break;
+          case 'UPPER_CASE':
+            if (eslintUtils.isUpperCase(name)) {
+              isPass = true;
+            }
+            break;
+        }
+      }
+      if (!isPass) {
+        context.report({
+          node: node,
+          messageId: messageId,
+          data: {
+            formats: formats.join(', ')
+          }
+        });
+      }
+    }
+    function checkJSXElement(node) {
+      if (!node) {
+        return false;
+      }
+      if (node.type === 'JSXElement' || node.type === 'JSXFragment') {
+        return true;
+      }
+      if (node.type === 'BlockStatement') {
+        for (const statement of node.body) {
+          if (statement.type === 'ReturnStatement') {
+            if (checkJSXElement(statement.argument)) {
+              return true;
+            }
+          } else if (checkJSXElement(statement)) {
+            return true;
+          }
+        }
+      }
+      if (node.type === 'ArrowFunctionExpression' || node.type === 'FunctionExpression') {
+        return checkJSXElement(node.body);
+      }
+      return false;
+    }
+    function getTypeReference(node) {
+      if (node.id.typeAnnotation && node.id.typeAnnotation.typeAnnotation) {
+        const typeAnnotation = node.id.typeAnnotation.typeAnnotation;
+        if (typeAnnotation.type === 'TSTypeReference' && typeAnnotation.typeName.type === 'Identifier') {
+          const typeName = typeAnnotation.typeName.name;
+          const typeNameLast = typeName.split('.').pop();
+          return typeNameLast;
+        }
+      }
+    }
+    return {
+      FunctionDeclaration(node) {
+        if (node.type === 'FunctionDeclaration' && node.id) {
+          const fnName = node.id.name;
+          const isReactComponent = checkJSXElement(node.body);
+          if (!isReactComponent) {
+            validate('func', {
+              node,
+              name: fnName
+            });
+          }
+        }
+      },
+      VariableDeclarator(node) {
+        if (node.id && node.init && ['FunctionExpression', 'ArrowFunctionExpression'].includes(node.init.type)) {
+          const fnName = node.id.name;
+          let isReactComponent = checkJSXElement(node.init.body);
+          const typeName = getTypeReference(node);
+          if (typeName && reactFCTypes.has(typeName)) {
+            isReactComponent = true;
+          }
+          if (!isReactComponent) {
+            validate('func', {
+              node,
+              name: fnName
+            });
+          }
+        } else if (node.id) {
+          const varName = node.id.name;
+          for (const excludeRegex of exclude) {
+            if (new RegExp(excludeRegex).test(varName)) {
+              return;
+            }
+          }
+          const typeName = getTypeReference(node);
+          if (typeName && otherTypes.has(typeName)) {
+            return;
+          }
+          if (node.id.parent && node.id.parent.init) {
+            let calleeName;
+            let shouldCheckReact = false;
+            if (node.id.parent.init.type === 'CallExpression') {
+              shouldCheckReact = true;
+              calleeName = node.id.parent.init.callee.name;
+            } else if (node.id.parent.init.type === 'TSAsExpression' && node.id.parent.init.expression && node.id.parent.init.expression.callee) {
+              shouldCheckReact = true;
+              calleeName = node.id.parent.init.expression.callee.name;
+            }
+            if (shouldCheckReact) {
+              if (!calleeName) {
+                return;
+              }
+              if (reactGlobalFuncs.has(calleeName) || reactGlobalFuncs.has(calleeName.split('.').pop())) {
+                return;
+              }
+            }
+          }
+          validate('var', {
+            node,
+            name: varName
+          });
+        }
+      }
+    };
+  }
+});
+
 var ruleFiles = /*#__PURE__*/Object.freeze({
   __proto__: null,
   rules_enforce_mui_icon_alias: enforceMuiIconAlias,
-  rules_func_naming: funcNaming,
   rules_import_monorepo: importMonorepo,
   rules_intl_id_missing: intlIdMissing,
   rules_intl_id_naming: intlIdNaming,
@@ -2700,7 +2773,8 @@ var ruleFiles = /*#__PURE__*/Object.freeze({
   rules_tss_class_naming: tssClassNaming,
   rules_tss_no_color_name: tssNoColorName,
   rules_tss_no_color_value: tssNoColorValue,
-  rules_tss_unused_classes: tssUnusedClasses
+  rules_tss_unused_classes: tssUnusedClasses,
+  rules_var_naming: varNaming
 });
 
 const plugin = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agilebot/eslint-plugin",
-  "version": "0.3.10",
+  "version": "0.3.12",
   "description": "Agilebot's ESLint plugin",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,8 +18,8 @@
     "node": "^18.18.0 || >=20.0.0"
   },
   "dependencies": {
-    "eslint-plugin-react": "^7.34.3",
-    "@agilebot/eslint-utils": "0.3.10"
+    "eslint-plugin-react": "^7.35.0",
+    "@agilebot/eslint-utils": "0.3.12"
   },
   "peerDependencies": {
     "eslint": "^7.0.0 || ^8.0.0"
@@ -31,7 +31,7 @@
     "@types/color-name": "^1.1.4",
     "@types/estree": "^1.0.5",
     "color-name": "^2.0.0",
-    "eslint-vitest-rule-tester": "^0.3.2",
+    "eslint-vitest-rule-tester": "^0.3.3",
     "typescript-eslint": "^7.16.0"
   },
   "scripts": {