@agilebot/eslint-plugin 0.1.5 → 0.2.0

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/README.md

@@ -1,11 +1,11 @@
-# @agilebot/eslint-plugin
-
-### Usage
-
-```bash
-npm install --save-dev eslint @agilebot/eslint-plugin
-```
-
-### Documentation
-
-See `docs` folder.
+# @agilebot/eslint-plugin
+
+### Usage
+
+```bash
+npm install --save-dev eslint @agilebot/eslint-plugin
+```
+
+### Documentation
+
+See `docs` folder.

package/lib/index.js

@@ -1,59 +1,58 @@
-// @ts-check
-const path = require('node:path');
-const { globSync } = require('fast-glob');
-
-// List all rules in rules folder
-const rulesPath = path.join(__dirname, 'rules');
-const ruleFiles = globSync('**/*.js', {
-  cwd: rulesPath
-});
-
-/**
- * @type {import('eslint').Linter.RulesRecord}
- */
-const rules = {};
-ruleFiles.forEach(file => {
-  const { dir, name } = path.parse(file);
-  const ruleName = `${dir}/${name}`;
-  rules[ruleName] = require(path.join(rulesPath, file));
-});
-
-module.exports.rules = rules;
-
-module.exports.configs = {
-  recommended: {
-    plugins: ['@agilebot'],
-    rules: {
-      'react-hooks/exhaustive-deps': 'off',
-      '@agilebot/react/better-exhaustive-deps': [
-        'warn',
-        {
-          checkMemoizedVariableIsStatic: true,
-          staticHooks: {
-            'useIpc.*': {
-              value: true,
-              regexp: true
-            },
-            useDialog: true,
-            useSnackbar: true,
-            useForm: true,
-            'use.*Store': {
-              value: true,
-              regexp: true
-            }
-          }
-        }
-      ],
-      '@agilebot/react/prefer-named-property-access': 'error',
-      '@agilebot/react/hook-use-ref': 'warn',
-      '@agilebot/react/no-inline-styles': 'error',
-      '@agilebot/tss/unused-classes': 'warn',
-      '@agilebot/tss/no-color-value': 'error',
-      '@agilebot/tss/class-naming': 'error',
-      '@agilebot/import/enforce-icon-alias': 'error',
-      '@agilebot/import/monorepo': 'error',
-      '@agilebot/others/no-unnecessary-template-literals': 'error'
-    },
-    settings: {}
-  }
-};
+// @ts-check
+const path = require('node:path');
+const { globSync } = require('fast-glob');
+
+// List all rules in rules folder
+const rulesPath = path.join(__dirname, 'rules');
+const ruleFiles = globSync('**/*.js', {
+  cwd: rulesPath
+});
+
+/**
+ * @type {import('eslint').Linter.RulesRecord}
+ */
+const rules = {};
+ruleFiles.forEach(file => {
+  const { dir, name } = path.parse(file);
+  const ruleName = `${dir}/${name}`;
+  rules[ruleName] = require(path.join(rulesPath, file));
+});
+
+module.exports.rules = rules;
+
+module.exports.configs = {
+  recommended: {
+    plugins: ['@agilebot'],
+    rules: {
+      'react-hooks/exhaustive-deps': 'off',
+      '@agilebot/react/better-exhaustive-deps': [
+        'warn',
+        {
+          checkMemoizedVariableIsStatic: true,
+          staticHooks: {
+            'useIpc.*': {
+              value: true,
+              regexp: true
+            },
+            useDialog: true,
+            useSnackbar: true,
+            useForm: true,
+            'use.*Store': {
+              value: true,
+              regexp: true
+            }
+          }
+        }
+      ],
+      '@agilebot/react/prefer-named-property-access': 'error',
+      '@agilebot/react/hook-use-ref': 'warn',
+      '@agilebot/react/no-inline-styles': 'error',
+      '@agilebot/tss/unused-classes': 'warn',
+      '@agilebot/tss/no-color-value': 'error',
+      '@agilebot/tss/class-naming': 'error',
+      '@agilebot/import/enforce-icon-alias': 'error',
+      '@agilebot/import/monorepo': 'error',
+      '@agilebot/others/no-unnecessary-template-literals': 'error'
+    }
+  }
+};

package/lib/rules/import/enforce-icon-alias.js

@@ -1,43 +1,42 @@
-module.exports = {
-  meta: {
-    type: 'problem', // `problem`, `suggestion`, or `layout`
-    docs: {
-      description: 'Enforce alias for @mui/icons-material imports',
-      recommended: true
-    },
-    fixable: 'code', // Or `code` or `whitespace`
-    schema: [] // Add a schema if the rule has options
-  },
-
-  create(context) {
-    return {
-      ImportDeclaration(node) {
-        if (
-          node.source.value !== '@mui/icons-material' &&
-          node.source.value !== 'mdi-material-ui'
-        ) {
-          return;
-        }
-
-        for (const specifier of node.specifiers) {
-          if (specifier.type !== 'ImportSpecifier') {
-            return;
-          }
-
-          if (specifier.imported.name === specifier.local.name) {
-            context.report({
-              node,
-              message: `Import for ${node.source.value} should be aliased.`,
-              fix: fixer => {
-                return fixer.replaceText(
-                  specifier,
-                  `${specifier.imported.name} as ${specifier.imported.name}Icon`
-                );
-              }
-            });
-          }
-        }
-      }
-    };
-  }
-};
+module.exports = {
+  meta: {
+    type: 'problem', // `problem`, `suggestion`, or `layout`
+    docs: {
+      description: 'Enforce alias for @mui/icons-material imports',
+      recommended: true
+    },
+    fixable: 'code', // Or `code` or `whitespace`
+    schema: [] // Add a schema if the rule has options
+  },
+
+  create(context) {
+    return {
+      ImportDeclaration(node) {
+        if (
+          node.source.value !== '@mui/icons-material' &&
+          node.source.value !== 'mdi-material-ui'
+        ) {
+          return;
+        }
+
+        for (const specifier of node.specifiers) {
+          if (specifier.type !== 'ImportSpecifier') {
+            return;
+          }
+
+          if (specifier.imported.name === specifier.local.name) {
+            context.report({
+              node,
+              message: `Import for ${node.source.value} should be aliased.`,
+              fix: fixer =>
+                fixer.replaceText(
+                  specifier,
+                  `${specifier.imported.name} as ${specifier.imported.name}Icon`
+                )
+            });
+          }
+        }
+      }
+    };
+  }
+};

package/lib/rules/import/monorepo.js

@@ -1,49 +1,49 @@
-const { getSetting } = require('../../util/settings');
-
-let warnedForMissingPrefix = false;
-
-module.exports = {
-  meta: {
-    type: 'problem', // `problem`, `suggestion`, or `layout`
-    docs: {
-      description: 'Enforce import styles for monorepo',
-      recommended: true
-    },
-    fixable: 'code', // Or `code` or `whitespace`
-    schema: [] // Add a schema if the rule has options
-  },
-
-  create(context) {
-    return {
-      ImportDeclaration(node) {
-        const prefix = getSetting(context, 'monorepo-prefix');
-        if (!prefix) {
-          if (!warnedForMissingPrefix) {
-            // eslint-disable-next-line no-console -- this is a CLI tool
-            console.error('Warning: agilebot/monorepo-prefix is not set.');
-            warnedForMissingPrefix = true;
-          }
-          return;
-        }
-
-        if (!node.source.value.startsWith(prefix)) {
-          return;
-        }
-        const values = node.source.value.split('/');
-
-        if (values[2] === 'src') {
-          context.report({
-            node,
-            message: `Import for ${node.source.value} should not contains src folder.`,
-            fix: fixer => {
-              const correctedPath = values
-                .filter((_, index) => index !== 2)
-                .join('/');
-              return fixer.replaceText(node.source, `'${correctedPath}'`);
-            }
-          });
-        }
-      }
-    };
-  }
-};
+const { getSetting } = require('../../util/settings');
+
+let warnedForMissingPrefix = false;
+
+module.exports = {
+  meta: {
+    type: 'problem', // `problem`, `suggestion`, or `layout`
+    docs: {
+      description: 'Enforce import styles for monorepo',
+      recommended: true
+    },
+    fixable: 'code', // Or `code` or `whitespace`
+    schema: [] // Add a schema if the rule has options
+  },
+
+  create(context) {
+    return {
+      ImportDeclaration(node) {
+        const prefix = getSetting(context, 'monorepo-prefix');
+        if (!prefix) {
+          if (!warnedForMissingPrefix) {
+            // eslint-disable-next-line no-console -- this is a CLI tool
+            console.error('Warning: agilebot/monorepo-prefix is not set.');
+            warnedForMissingPrefix = true;
+          }
+          return;
+        }
+
+        if (!node.source.value.startsWith(prefix)) {
+          return;
+        }
+        const values = node.source.value.split('/');
+
+        if (values[2] === 'src') {
+          context.report({
+            node,
+            message: `Import for ${node.source.value} should not contains src folder.`,
+            fix: fixer => {
+              const correctedPath = values
+                .filter((_, index) => index !== 2)
+                .join('/');
+              return fixer.replaceText(node.source, `'${correctedPath}'`);
+            }
+          });
+        }
+      }
+    };
+  }
+};

package/lib/rules/intl/id-missing.js

@@ -1,105 +1,111 @@
-const {
-  sortedTemplateElements,
-  templateLiteralDisplayStr,
-  findFormatMessageAttrNode,
-  findFormattedMessageAttrNode,
-  findAttrNodeInDefineMessages,
-  findAttrNodeInDefineMessage
-} = require('../../util/intl');
-const { getIntlIds } = require('../../util/translations');
-
-// ------------------------------------------------------------------------------
-// Rule Definition
-// ------------------------------------------------------------------------------
-
-module.exports = {
-  meta: {
-    docs: {
-      description: 'Validates intl message ids are in locale file',
-      category: 'Intl',
-      recommended: true
-    },
-    fixable: null,
-    schema: []
-  },
-
-  create: function (context) {
-    const translatedIds = getIntlIds(context);
-    const translatedIdSet = new Set(translatedIds);
-
-    // ----------------------------------------------------------------------
-    // Helpers
-    // ----------------------------------------------------------------------
-
-    function isLiteralTranslated(id) {
-      return translatedIdSet.has(id);
-    }
-
-    function isTemplateTranslated(re) {
-      return translatedIds.some(k => re.test(k));
-    }
-
-    function processLiteral(node) {
-      if (!isLiteralTranslated(node.value)) {
-        context.report({
-          node: node,
-          message: 'Missing id: ' + node.value
-        });
-      }
-    }
-
-    function processTemplateLiteral(node) {
-      const exStr = sortedTemplateElements(node)
-        .map(e => (!e.value ? '.*' : e.value.raw))
-        .join('');
-      const re = new RegExp(exStr);
-
-      if (!isTemplateTranslated(re)) {
-        context.report({
-          node: node,
-          message: 'Missing id pattern: ' + templateLiteralDisplayStr(node)
-        });
-      }
-    }
-
-    function processAttrNode(node) {
-      if (node.value.type === 'Literal') {
-        return processLiteral(node.value);
-      }
-      if (
-        node.value.type === 'JSXExpressionContainer' &&
-        node.value.expression.type === 'TemplateLiteral'
-      ) {
-        return processTemplateLiteral(node.value.expression);
-      }
-      if (node.value.type === 'TemplateLiteral') {
-        return processTemplateLiteral(node.value);
-      }
-      context.report({
-        node: node,
-        message: 'Do not invoke intl by ' + node.value.type
-      });
-    }
-
-    // ----------------------------------------------------------------------
-    // Public
-    // ----------------------------------------------------------------------
-
-    return {
-      JSXIdentifier: function (node) {
-        const attrNode = findFormattedMessageAttrNode(node, 'id');
-        if (attrNode) return processAttrNode(attrNode);
-      },
-      CallExpression: function (node) {
-        const attrNode = findFormatMessageAttrNode(node, 'id');
-        if (attrNode) return processAttrNode(attrNode);
-      },
-      Property: function (node) {
-        const attrNode =
-          findAttrNodeInDefineMessages(node, 'id') ||
-          findAttrNodeInDefineMessage(node, 'id');
-        if (attrNode) return processAttrNode(attrNode);
-      }
-    };
-  }
-};
+const {
+  sortedTemplateElements,
+  templateLiteralDisplayStr,
+  findFormatMessageAttrNode,
+  findFormattedMessageAttrNode,
+  findAttrNodeInDefineMessages,
+  findAttrNodeInDefineMessage
+} = require('../../util/intl');
+const { getIntlIds } = require('../../util/translations');
+
+// ------------------------------------------------------------------------------
+// Rule Definition
+// ------------------------------------------------------------------------------
+
+module.exports = {
+  meta: {
+    docs: {
+      description: 'Validates intl message ids are in locale file',
+      category: 'Intl',
+      recommended: true
+    },
+    fixable: null,
+    schema: []
+  },
+
+  create: function (context) {
+    const translatedIds = getIntlIds(context);
+    const translatedIdSet = new Set(translatedIds);
+
+    // ----------------------------------------------------------------------
+    // Helpers
+    // ----------------------------------------------------------------------
+
+    function isLiteralTranslated(id) {
+      return translatedIdSet.has(id);
+    }
+
+    function isTemplateTranslated(re) {
+      return translatedIds.some(k => re.test(k));
+    }
+
+    function processLiteral(node) {
+      if (!isLiteralTranslated(node.value)) {
+        context.report({
+          node: node,
+          message: 'Missing id: ' + node.value
+        });
+      }
+    }
+
+    function processTemplateLiteral(node) {
+      const exStr = sortedTemplateElements(node)
+        .map(e => (!e.value ? '.*' : e.value.raw))
+        .join('');
+      const re = new RegExp(exStr);
+
+      if (!isTemplateTranslated(re)) {
+        context.report({
+          node: node,
+          message: 'Missing id pattern: ' + templateLiteralDisplayStr(node)
+        });
+      }
+    }
+
+    function processAttrNode(node) {
+      if (node.value.type === 'Literal') {
+        return processLiteral(node.value);
+      }
+      if (
+        node.value.type === 'JSXExpressionContainer' &&
+        node.value.expression.type === 'TemplateLiteral'
+      ) {
+        return processTemplateLiteral(node.value.expression);
+      }
+      if (node.value.type === 'TemplateLiteral') {
+        return processTemplateLiteral(node.value);
+      }
+      context.report({
+        node: node,
+        message: 'Do not invoke intl by ' + node.value.type
+      });
+    }
+
+    // ----------------------------------------------------------------------
+    // Public
+    // ----------------------------------------------------------------------
+
+    return {
+      JSXIdentifier: function (node) {
+        const attrNode = findFormattedMessageAttrNode(node, 'id');
+        if (attrNode) {
+          return processAttrNode(attrNode);
+        }
+      },
+      CallExpression: function (node) {
+        const attrNode = findFormatMessageAttrNode(node, 'id');
+        if (attrNode) {
+          return processAttrNode(attrNode);
+        }
+      },
+      Property: function (node) {
+        const attrNode =
+          findAttrNodeInDefineMessages(node, 'id') ||
+          findAttrNodeInDefineMessage(node, 'id');
+        if (attrNode) {
+          return processAttrNode(attrNode);
+        }
+      }
+    };
+  }
+};