@agilebot/eslint-plugin 0.3.8 → 0.3.10

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,17 +1,16 @@
-/**
- * @license @agilebot/eslint-plugin v0.3.8
- *
- * 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.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.
+ */
 'use strict';
 
 var eslintUtils = require('@agilebot/eslint-utils');
 var fs = require('node:fs');
 var path = require('node:path');
-var utils = require('@typescript-eslint/utils');
 
 function _interopNamespaceDefault(e) {
   var n = Object.create(null);
@@ -33,12 +32,12 @@ function _interopNamespaceDefault(e) {
 var fs__namespace = /*#__PURE__*/_interopNamespaceDefault(fs);
 var path__namespace = /*#__PURE__*/_interopNamespaceDefault(path);
 
-var enforceMuiIconAlias = {
+var enforceMuiIconAlias = eslintUtils.createESLintRule({
   meta: {
     type: 'problem',
     docs: {
       description: 'Enforce alias for @mui/icons-material imports',
-      recommended: true
+      recommended: 'recommended'
     },
     fixable: 'code',
     schema: [],
@@ -46,6 +45,7 @@ var enforceMuiIconAlias = {
       iconAlias: 'Import for {{ name }} should be aliased.'
     }
   },
+  defaultOptions: [],
   create(context) {
     return {
       ImportDeclaration(node) {
@@ -70,10 +70,11 @@ var enforceMuiIconAlias = {
       }
     };
   }
-};
+});
 
-var funcNaming = {
+var funcNaming = eslintUtils.createESLintRule({
   meta: {
+    type: 'problem',
     docs: {
       description: 'Enforce function naming convention'
     },
@@ -81,6 +82,7 @@ var funcNaming = {
       type: 'object',
       properties: {
         format: {
+          type: 'string',
           "enum": ['camelCase', 'PascalCase']
         }
       }
@@ -90,6 +92,7 @@ var funcNaming = {
       invalidReactFCNaming: 'Invalid naming convention for React functional component, expected PascalCase'
     }
   },
+  defaultOptions: [],
   create(context) {
     if (!context.options[0]) {
       throw new Error('Missing options');
@@ -162,14 +165,15 @@ var funcNaming = {
         }
       },
       VariableDeclarator(node) {
-        if (node.init && ['FunctionExpression', 'ArrowFunctionExpression'].includes(node.init.type)) {
+        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;
-              if (['FC', 'React.FC', 'FunctionComponent', 'React.FunctionComponent'].includes(typeName)) {
+              const typeNameLast = typeName.split('.').pop();
+              if (['FC', 'FunctionComponent', 'VFC', 'VoidFunctionComponent'].includes(typeNameLast)) {
                 isReactComponent = true;
               }
             }
@@ -187,7 +191,7 @@ var funcNaming = {
       }
     };
   }
-};
+});
 
 function getSetting(context, name) {
   return context.settings["agilebot/".concat(name)];
@@ -202,12 +206,12 @@ function warnOnce(message) {
   console.warn("Warning: ".concat(message));
 }
 
-var importMonorepo = {
+var importMonorepo = eslintUtils.createESLintRule({
   meta: {
     type: 'problem',
     docs: {
       description: 'Enforce import styles for monorepo',
-      recommended: true
+      recommended: 'recommended'
     },
     fixable: 'code',
     schema: [],
@@ -215,6 +219,7 @@ var importMonorepo = {
       monorepoImport: 'Import for {{ module }} should not contains src folder.'
     }
   },
+  defaultOptions: [],
   create(context) {
     return {
       ImportDeclaration(node) {
@@ -247,7 +252,7 @@ var importMonorepo = {
       }
     };
   }
-};
+});
 
 function findFormatMessageAttrNode(node, attrName) {
   if (node.type === 'CallExpression' && (node.callee.name === 'formatMessage' || node.callee.name === '$t') && node.arguments.length > 0 && node.arguments[0].properties) {
@@ -317,15 +322,20 @@ function getIntlIds(context) {
   return results;
 }
 
-var intlIdMissing = {
+var intlIdMissing = eslintUtils.createESLintRule({
   meta: {
+    type: 'problem',
     docs: {
-      description: 'Validates intl message ids are in locale file',
-      category: 'Intl'
+      description: 'Validates intl message ids are in locale file'
     },
-    fixable: undefined,
-    schema: []
+    schema: [],
+    messages: {
+      missingId: 'Missing id: {{value}}',
+      missingIdPattern: 'Missing id pattern: {{value}}',
+      disallowInvoke: 'Do not invoke intl by {{value}}'
+    }
   },
+  defaultOptions: [],
   create: function (context) {
     const translatedIds = getIntlIds(context);
     const translatedIdSet = new Set(translatedIds);
@@ -339,7 +349,10 @@ var intlIdMissing = {
       if (!isLiteralTranslated(node.value)) {
         context.report({
           node: node,
-          message: 'Missing id: ' + node.value
+          messageId: 'missingId',
+          data: {
+            value: node.value
+          }
         });
       }
     }
@@ -349,7 +362,10 @@ var intlIdMissing = {
       if (!isTemplateTranslated(re)) {
         context.report({
           node: node,
-          message: 'Missing id pattern: ' + templateLiteralDisplayStr(node)
+          messageId: 'missingIdPattern',
+          data: {
+            value: templateLiteralDisplayStr(node)
+          }
         });
       }
     }
@@ -365,7 +381,10 @@ var intlIdMissing = {
       }
       context.report({
         node: node,
-        message: 'Do not invoke intl by ' + node.value.type
+        messageId: 'disallowInvoke',
+        data: {
+          value: node.value.type
+        }
       });
     }
     return {
@@ -389,19 +408,19 @@ var intlIdMissing = {
       }
     };
   }
-};
+});
 
-var intlIdNaming = {
+var intlIdNaming = eslintUtils.createESLintRule({
   meta: {
+    type: 'problem',
     docs: {
-      description: 'Validates intl message ids naming convention',
-      category: 'Intl'
+      description: 'Validates intl message ids naming convention'
     },
-    fixable: undefined,
     schema: [{
       type: 'object',
       properties: {
         format: {
+          type: 'string',
           "enum": ['camelCase', 'PascalCase']
         }
       }
@@ -410,6 +429,7 @@ var intlIdNaming = {
       invalidIdNaming: "Invalid id naming, expected {{format}}"
     }
   },
+  defaultOptions: [],
   create: function (context) {
     if (!context.options[0]) {
       throw new Error('Missing options');
@@ -481,22 +501,25 @@ var intlIdNaming = {
       }
     };
   }
-};
+});
 
-var intlIdPrefix = {
+var intlIdPrefix = eslintUtils.createESLintRule({
   meta: {
+    type: 'problem',
     docs: {
-      description: 'Validates intl message ids has correct prefixes',
-      category: 'Intl'
+      description: 'Validates intl message ids has correct prefixes'
     },
-    fixable: undefined,
     schema: [{
       type: 'array',
       items: {
         type: 'string'
       }
-    }]
+    }],
+    messages: {
+      invalidIdPrefix: 'Invalid id prefix: {{value}}'
+    }
   },
+  defaultOptions: [],
   create: function (context) {
     if (context.options[0].length === 0) {
       throw new Error('Prefixes are required in settings');
@@ -506,7 +529,10 @@ var intlIdPrefix = {
       if (!hasPrefix(value)) {
         context.report({
           node: node,
-          message: "Invalid id prefix: ".concat(value)
+          messageId: 'invalidIdPrefix',
+          data: {
+            value
+          }
         });
       }
     }
@@ -549,18 +575,19 @@ var intlIdPrefix = {
       }
     };
   }
-};
+});
 
 const usedIds = new Map();
-var intlIdUnused = {
+var intlIdUnused = eslintUtils.createESLintRule({
   meta: {
+    type: 'problem',
     docs: {
-      description: 'Finds unused intl message ids in locale file',
-      category: 'Intl'
+      description: 'Finds unused intl message ids in locale file'
     },
-    fixable: undefined,
-    schema: []
+    schema: [],
+    messages: {}
   },
+  defaultOptions: [],
   create: function (context) {
     const projectRoot = getSetting(context, 'project-root');
     if (!projectRoot) {
@@ -625,22 +652,25 @@ var intlIdUnused = {
       }
     };
   }
-};
+});
 
-var intlNoDefault = {
+var intlNoDefault = eslintUtils.createESLintRule({
   meta: {
+    type: 'problem',
     docs: {
-      description: 'Validates defaultMessage is not used with react-intl',
-      category: 'Intl'
+      description: 'Validates defaultMessage is not used with react-intl'
     },
-    fixable: undefined,
-    schema: []
+    schema: [],
+    messages: {
+      noDefaultMessage: 'Do not use defaultMessage'
+    }
   },
+  defaultOptions: [],
   create: function (context) {
     function processAttrNode(node) {
       context.report({
         node: node,
-        message: 'Do not use defaultMessage'
+        messageId: 'noDefaultMessage'
       });
     }
     return {
@@ -664,21 +694,21 @@ var intlNoDefault = {
       }
     };
   }
-};
+});
 
-var noAsyncArrayMethods = {
+var noAsyncArrayMethods = eslintUtils.createESLintRule({
   meta: {
+    type: 'problem',
     docs: {
       description: 'No async callback for Array methods forEach, map, filter, reduce, some, every, etc.',
-      category: 'Array',
-      recommended: true
+      recommended: 'recommended'
     },
-    fixable: undefined,
     schema: [],
     messages: {
       noAsyncArrayMethods: "No async function in method '{{ methodName }}'"
     }
   },
+  defaultOptions: [],
   create: function (context) {
     return {
       ExpressionStatement: function (node) {
@@ -706,21 +736,21 @@ var noAsyncArrayMethods = {
       }
     };
   }
-};
+});
 
-var noImportCss = {
+var noImportCss = eslintUtils.createESLintRule({
   meta: {
     type: 'problem',
     docs: {
       description: 'Prevent importing CSS',
-      recommended: true
+      recommended: 'recommended'
     },
-    fixable: 'code',
     schema: [],
     messages: {
       noImportCSS: 'Do not import CSS files. Use CSS-in-JS instead.'
     }
   },
+  defaultOptions: [],
   create(context) {
     return {
       ImportDeclaration(node) {
@@ -737,9 +767,9 @@ var noImportCss = {
       }
     };
   }
-};
+});
 
-var noThenCatchFinally = {
+var noThenCatchFinally = eslintUtils.createESLintRule({
   meta: {
     type: 'suggestion',
     docs: {
@@ -761,6 +791,7 @@ var noThenCatchFinally = {
       forbiddenThenCatchFinally: "then()/catch()/finally() is forbidden when invoke {{ name }}()."
     }
   },
+  defaultOptions: [],
   create(context) {
     const configuration = context.options[0] || {};
     const restrictedFunctions = configuration.restrictedFunctions || [];
@@ -791,14 +822,14 @@ var noThenCatchFinally = {
       }
     };
   }
-};
+});
 
-var noUnnecessaryTemplateLiterals = {
+var noUnnecessaryTemplateLiterals = eslintUtils.createESLintRule({
   meta: {
     type: 'problem',
     docs: {
       description: 'Check if a template string contains only one ${}',
-      recommended: true
+      recommended: 'recommended'
     },
     fixable: 'code',
     schema: [],
@@ -806,6 +837,7 @@ var noUnnecessaryTemplateLiterals = {
       unnecessaryTemplateString: 'Unnecessary template string with only one ${}.'
     }
   },
+  defaultOptions: [],
   create(context) {
     return {
       TemplateLiteral(node) {
@@ -822,7 +854,7 @@ var noUnnecessaryTemplateLiterals = {
       }
     };
   }
-};
+});
 
 var reactBetterExhaustiveDeps = {
   meta: {
@@ -2016,19 +2048,20 @@ function isAncestorNodeOf(a, b) {
 }
 
 const Components = require('eslint-plugin-react/lib/util/Components');
-var reactHookUseRef = {
+var reactHookUseRef = eslintUtils.createESLintRule({
   meta: {
+    type: 'suggestion',
     docs: {
       description: 'Ensure naming of useRef hook value.',
-      recommended: true
+      recommended: 'recommended'
     },
     schema: [],
-    type: 'suggestion',
     hasSuggestions: true,
     messages: {
       useRefName: 'useRef call is not end with "Ref"'
     }
   },
+  defaultOptions: [],
   create: Components.detect((context, component, util) => ({
     CallExpression(node) {
       const isImmediateReturn = node.parent && node.parent.type === 'ReturnStatement';
@@ -2047,7 +2080,7 @@ var reactHookUseRef = {
       }
     }
   }))
-};
+});
 
 function* updateImportStatement(context, fixer, key) {
   const sourceCode = context.sourceCode;
@@ -2066,20 +2099,21 @@ function* updateImportStatement(context, fixer, key) {
   }
   yield fixer.insertTextAfter([...importNode.specifiers].pop(), ", ".concat(key));
 }
-var reactPreferNamedPropertyAccess = utils.ESLintUtils.RuleCreator.withoutDocs({
-  defaultOptions: [],
+var reactPreferNamedPropertyAccess = eslintUtils.createESLintRule({
   meta: {
-    type: 'layout',
+    type: 'problem',
     fixable: 'code',
     docs: {
       description: 'Enforce importing each member of React namespace separately instead of accessing them through React namespace',
       recommended: 'recommended'
     },
     messages: {
-      illegalReactPropertyAccess: 'Illegal React property access: {{name}}. Use named import instead.'
+      illegalReactPropertyAccess: 'Illegal React property access: {{name}}. Use named import instead.',
+      disallowImportReactEvent: 'Disallow importing React event types to avoid conflicts with global event types.'
     },
     schema: []
   },
+  defaultOptions: [],
   create(context) {
     return {
       TSQualifiedName(node) {
@@ -2113,17 +2147,30 @@ var reactPreferNamedPropertyAccess = utils.ESLintUtils.RuleCreator.withoutDocs({
             yield* updateImportStatement(context, fixer, node.property.name);
           }
         });
+      },
+      ImportDeclaration(node) {
+        if (node.source.value !== 'react' && node.source.value !== 'preact') {
+          return;
+        }
+        node.specifiers.forEach(specifier => {
+          if (specifier.type === 'ImportSpecifier' && specifier.imported.name && specifier.imported.name.endsWith('Event')) {
+            context.report({
+              node: specifier,
+              messageId: 'disallowImportReactEvent'
+            });
+          }
+        });
       }
     };
   }
 });
 
-var reactPreferSxProp = {
+var reactPreferSxProp = eslintUtils.createESLintRule({
   meta: {
+    type: 'problem',
     docs: {
       description: 'Prefer using sx prop instead of inline styles',
-      category: 'Best Practices',
-      recommended: true
+      recommended: 'recommended'
     },
     messages: {
       preferSxProp: 'Avoid using inline styles, use sx prop or tss-react or styled-component instead'
@@ -2141,6 +2188,7 @@ var reactPreferSxProp = {
       }
     }]
   },
+  defaultOptions: [],
   create(context) {
     const configuration = context.options[0] || {};
     const allowedFor = configuration.allowedFor || [];
@@ -2185,7 +2233,7 @@ var reactPreferSxProp = {
       }
     };
   }
-};
+});
 
 function getBasicIdentifier(node) {
   if (node.type === 'Identifier') {
@@ -2276,18 +2324,19 @@ function loopStylesObj(node, callback) {
   }
 }
 
-var tssClassNaming = {
+var tssClassNaming = eslintUtils.createESLintRule({
   meta: {
     type: 'problem',
     docs: {
       description: 'Enforce camelCase class names in TSS',
-      category: 'Best Practices',
-      recommended: true
+      recommended: 'recommended'
     },
+    schema: [],
     messages: {
       camelCase: 'Class `{{ className }}` must be camelCase in TSS.'
     }
   },
+  defaultOptions: [],
   create: function rule(context) {
     return {
       CallExpression(node) {
@@ -2316,7 +2365,7 @@ var tssClassNaming = {
       }
     };
   }
-};
+});
 
 var colors = {
   aliceblue: [240, 248, 255],
@@ -2469,17 +2518,19 @@ var colors = {
   yellowgreen: [154, 205, 50]
 };
 
-var tssNoColorName = {
+var tssNoColorName = eslintUtils.createESLintRule({
   meta: {
     type: 'suggestion',
     docs: {
       description: 'Enforce the use of color variables instead of color name within TSS',
-      recommended: true
+      recommended: 'recommended'
     },
+    schema: [],
     messages: {
       disallowColorName: 'Disallowed color name. Use color from `@mui/material/colors` or `theme.palette`.'
     }
   },
+  defaultOptions: [],
   create: function (context) {
     return {
       CallExpression(node) {
@@ -2499,19 +2550,21 @@ var tssNoColorName = {
       }
     };
   }
-};
+});
 
-var tssNoColorValue = {
+var tssNoColorValue = eslintUtils.createESLintRule({
   meta: {
     type: 'problem',
     docs: {
       description: 'Enforce the use of color variables instead of color codes within TSS',
-      recommended: true
+      recommended: 'recommended'
     },
+    schema: [],
     messages: {
       preferMuiColor: 'Prefer use color from `@mui/material/colors` or `theme.palette`.'
     }
   },
+  defaultOptions: [],
   create: function (context) {
     return {
       CallExpression(node) {
@@ -2534,20 +2587,21 @@ var tssNoColorValue = {
       }
     };
   }
-};
+});
 
-var tssUnusedClasses = {
+var tssUnusedClasses = eslintUtils.createESLintRule({
   meta: {
     type: 'suggestion',
     docs: {
       description: 'Disallow unused classes in tss',
-      category: 'Best Practices',
-      recommended: true
+      recommended: 'recommended'
     },
+    schema: [],
     messages: {
       unusedClass: 'Class `{{ className }}` is unused in JSX'
     }
   },
+  defaultOptions: [],
   create: function rule(context) {
     const usedClasses = {};
     const definedClasses = {};
@@ -2623,7 +2677,7 @@ var tssUnusedClasses = {
       }
     };
   }
-};
+});
 
 var ruleFiles = /*#__PURE__*/Object.freeze({
   __proto__: null,
@@ -2669,7 +2723,7 @@ Object.keys(ruleFiles).forEach(key => {
   const rule = ruleFiles[key];
   plugin.rules[finalKey] = rule;
   if (rule.meta && rule.meta.docs && rule.meta.docs.recommended) {
-    plugin.configs.recommended.rules["@agilebot/".concat(finalKey)] = rule.meta.type === 'suggestion' ? 'warn' : 'error';
+    plugin.configs.recommended.rules["@agilebot/".concat(finalKey)] = rule.meta.type === 'problem' ? 'error' : 'warn';
   }
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agilebot/eslint-plugin",
-  "version": "0.3.8",
+  "version": "0.3.10",
   "description": "Agilebot's ESLint plugin",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,9 +18,8 @@
     "node": "^18.18.0 || >=20.0.0"
   },
   "dependencies": {
-    "@typescript-eslint/utils": "~7.9.0",
-    "eslint-plugin-react": "^7.34.1",
-    "@agilebot/eslint-utils": "0.3.8"
+    "eslint-plugin-react": "^7.34.3",
+    "@agilebot/eslint-utils": "0.3.10"
   },
   "peerDependencies": {
     "eslint": "^7.0.0 || ^8.0.0"
@@ -32,7 +31,8 @@
     "@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.2",
+    "typescript-eslint": "^7.16.0"
   },
   "scripts": {
     "build": "rollup -c rollup.config.mjs",