@agilebot/eslint-plugin 0.1.1 → 0.1.3

package/lib/index.js

@@ -1,52 +1,59 @@
-const path = require('path');
-const { globSync } = require('fast-glob');
-
-// List all rules in rules folder
-const rulesPath = path.join(__dirname, 'rules');
-const ruleFiles = globSync('**/*.js', {
-  cwd: rulesPath,
-  depth: 2
-});
-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: {
-            useIpcSender: 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'
+    },
+    settings: {}
+  }
+};

package/lib/rules/import/monorepo.js

@@ -1,44 +1,49 @@
-const { consola } = require('consola');
-const { getSetting } = require('../../util/settings');
-
-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) {
-          consola.warn('agilebot/monorepo-prefix is not set');
-          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-unused.js

@@ -1,117 +1,117 @@
-const path = require('path');
-const fs = require('fs');
-const {
-  sortedTemplateElements,
-  findFormatMessageAttrNode,
-  findFormattedMessageAttrNode,
-  findAttrNodeInDefineMessages,
-  findAttrNodeInDefineMessage
-} = require('../../util/intl');
-const { getIntlIds } = require('../../util/translations');
-const { getSetting } = require('../../util/settings');
-
-// 已经使用的id集合 key为项目目录，value为id集合Set
-const usedIds = new Map();
-
-// ------------------------------------------------------------------------------
-// Rule Definition
-// ------------------------------------------------------------------------------
-
-module.exports = {
-  meta: {
-    docs: {
-      description: 'Finds unused intl message ids in locale file',
-      category: 'Intl',
-      recommended: true
-    },
-    fixable: null,
-    schema: []
-  },
-
-  create: function (context) {
-    const projectRoot = getSetting(context, 'project-root');
-    if (!projectRoot) {
-      throw new Error('projectRoot must be set in this rule');
-    }
-    if (!usedIds.has(projectRoot)) {
-      usedIds.set(projectRoot, new Set());
-    }
-    const usedIdSet = usedIds.get(projectRoot);
-
-    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)) {
-        // 将已使用的id加入usedIdSet
-        usedIdSet.add(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)) {
-        // TODO: 暂时没有这种情况
-      }
-    }
-
-    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);
-      }
-    }
-
-    // ----------------------------------------------------------------------
-    // 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);
-      },
-      'Program:exit': function () {
-        // 将usedIdSet转为数组，然后与translatedIds取差集，即为未使用的id
-        const unusedIds = [...translatedIdSet].filter(id => !usedIdSet.has(id));
-        // 在项目目录下生成intl-unused.json
-        const jsonPath = path.join(projectRoot, 'intl-unused.json');
-        fs.writeFileSync(jsonPath, JSON.stringify(unusedIds, null, 2));
-      }
-    };
-  }
-};
+const path = require('node:path');
+const fs = require('node:fs');
+const {
+  sortedTemplateElements,
+  findFormatMessageAttrNode,
+  findFormattedMessageAttrNode,
+  findAttrNodeInDefineMessages,
+  findAttrNodeInDefineMessage
+} = require('../../util/intl');
+const { getIntlIds } = require('../../util/translations');
+const { getSetting } = require('../../util/settings');
+
+// 已经使用的id集合 key为项目目录，value为id集合Set
+const usedIds = new Map();
+
+// ------------------------------------------------------------------------------
+// Rule Definition
+// ------------------------------------------------------------------------------
+
+module.exports = {
+  meta: {
+    docs: {
+      description: 'Finds unused intl message ids in locale file',
+      category: 'Intl',
+      recommended: true
+    },
+    fixable: null,
+    schema: []
+  },
+
+  create: function (context) {
+    const projectRoot = getSetting(context, 'project-root');
+    if (!projectRoot) {
+      throw new Error('projectRoot must be set in this rule');
+    }
+    if (!usedIds.has(projectRoot)) {
+      usedIds.set(projectRoot, new Set());
+    }
+    const usedIdSet = usedIds.get(projectRoot);
+
+    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)) {
+        // 将已使用的id加入usedIdSet
+        usedIdSet.add(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)) {
+        // TODO: 暂时没有这种情况
+      }
+    }
+
+    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);
+      }
+    }
+
+    // ----------------------------------------------------------------------
+    // 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);
+      },
+      'Program:exit': function () {
+        // 将usedIdSet转为数组，然后与translatedIds取差集，即为未使用的id
+        const unusedIds = [...translatedIdSet].filter(id => !usedIdSet.has(id));
+        // 在项目目录下生成intl-unused.json
+        const jsonPath = path.join(projectRoot, 'intl-unused.json');
+        fs.writeFileSync(jsonPath, JSON.stringify(unusedIds, null, 2));
+      }
+    };
+  }
+};