@agilebot/eslint-plugin 0.1.2 → 0.1.4

package/lib/index.js

@@ -1,52 +1,59 @@
-// @ts-check
-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
-});
-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,6 +1,7 @@
-const { consola } = require('consola');
 const { getSetting } = require('../../util/settings');
 
+let warnedForMissingPrefix = false;
+
 module.exports = {
   meta: {
     type: 'problem', // `problem`, `suggestion`, or `layout`
@@ -17,7 +18,11 @@ module.exports = {
       ImportDeclaration(node) {
         const prefix = getSetting(context, 'monorepo-prefix');
         if (!prefix) {
-          consola.warn('agilebot/monorepo-prefix is not set');
+          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;
         }
 

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

@@ -1,5 +1,5 @@
-const path = require('path');
-const fs = require('fs');
+const path = require('node:path');
+const fs = require('node:fs');
 const {
   sortedTemplateElements,
   findFormatMessageAttrNode,

package/lib/rules/react/better-exhaustive-deps.js

@@ -1,6 +1,3 @@
-/* eslint-disable no-case-declarations */
-/* eslint-disable no-continue */
-
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
@@ -96,12 +93,13 @@ module.exports = {
     };
 
     function reportProblem(problem) {
-      if (enableDangerousAutofixThisMayCauseInfiniteLoops) {
-        // Used to enable legacy behavior. Dangerous.
+      if (
+        enableDangerousAutofixThisMayCauseInfiniteLoops && // Used to enable legacy behavior. Dangerous.
         // Keep this as an option until major IDEs upgrade (including VSCode FB ESLint extension).
-        if (Array.isArray(problem.suggest) && problem.suggest.length > 0) {
-          problem.fix = problem.suggest[0].fix;
-        }
+        Array.isArray(problem.suggest) &&
+        problem.suggest.length > 0
+      ) {
+        problem.fix = problem.suggest[0].fix;
       }
       context.report(problem);
     }
@@ -286,17 +284,14 @@ module.exports = {
               if (name === 'useState') {
                 const references = resolved.references;
                 let writeCount = 0;
-                for (let i = 0; i < references.length; i++) {
-                  if (references[i].isWrite()) {
+                for (const reference of references) {
+                  if (reference.isWrite()) {
                     writeCount++;
                   }
                   if (writeCount > 1) {
                     return false;
                   }
-                  setStateCallSites.set(
-                    references[i].identifier,
-                    id.elements[0]
-                  );
+                  setStateCallSites.set(reference.identifier, id.elements[0]);
                 }
               }
               // Setter is stable.
@@ -304,8 +299,8 @@ module.exports = {
             } else if (id.elements[0] === resolved.identifiers[0]) {
               if (name === 'useState') {
                 const references = resolved.references;
-                for (let i = 0; i < references.length; i++) {
-                  stateVariables.add(references[i].identifier);
+                for (const reference of references) {
+                  stateVariables.add(reference.identifier);
                 }
               }
               // State variable itself is dynamic.
@@ -317,13 +312,11 @@ module.exports = {
           if (
             id.type === 'ArrayPattern' &&
             id.elements.length === 2 &&
-            Array.isArray(resolved.identifiers)
+            Array.isArray(resolved.identifiers) && // Is second tuple value the same reference we're checking?
+            id.elements[1] === resolved.identifiers[0]
           ) {
-            // Is second tuple value the same reference we're checking?
-            if (id.elements[1] === resolved.identifiers[0]) {
-              // Setter is stable.
-              return true;
-            }
+            // Setter is stable.
+            return true;
           }
         } else if (
           options.checkMemoizedVariableIsStatic &&
@@ -350,7 +343,7 @@ module.exports = {
             );
 
             if (
-              typeof dependencyRefernece !== 'undefined' &&
+              dependencyRefernece !== undefined &&
               memoizedIsStableKnownHookValue(dependencyRefernece.resolved)
             ) {
               continue;
@@ -372,7 +365,6 @@ module.exports = {
             }
           });
 
-          // eslint-disable-next-line no-lonely-if
           if (options.staticHooks[name]) {
             const staticParts = options.staticHooks[name];
             if (staticParts === true) {
@@ -386,9 +378,7 @@ module.exports = {
                 Array.isArray(resolved.identifiers)
               ) {
                 // find index of the resolved ident in the array pattern
-                const idx = id.elements.findIndex(
-                  ident => ident === resolved.identifiers[0]
-                );
+                const idx = id.elements.indexOf(resolved.identifiers[0]);
                 if (idx >= 0) {
                   return staticParts[idx];
                 }
@@ -587,8 +577,7 @@ module.exports = {
           // Is React managing this ref or us?
           // Let's see if we can find a .current assignment.
           let foundCurrentAssignment = false;
-          for (let i = 0; i < references.length; i++) {
-            const { identifier } = references[i];
+          for (const { identifier } of references) {
             const { parent } = identifier;
             if (
               parent != null &&
@@ -764,8 +753,8 @@ module.exports = {
               declaredDependencyNode,
               null
             );
-          } catch (error) {
-            if (/Unsupported node type/.test(error.message)) {
+          } catch (err) {
+            if (/Unsupported node type/.test(err.message)) {
               if (declaredDependencyNode.type === 'Literal') {
                 if (dependencies.has(declaredDependencyNode.value)) {
                   reportProblem({
@@ -795,7 +784,7 @@ module.exports = {
 
               return;
             }
-            throw error;
+            throw err;
           }
 
           let maybeID = declaredDependencyNode;
@@ -942,7 +931,7 @@ module.exports = {
           return true;
         }
         const declaredDepKeys = declaredDependencies.map(dep => dep.key);
-        const sortedDeclaredDepKeys = declaredDepKeys.slice().sort();
+        const sortedDeclaredDepKeys = [...declaredDepKeys].sort();
         return declaredDepKeys.join(',') === sortedDeclaredDepKeys.join(',');
       }
       if (areDeclaredDepsAlphabetized()) {
@@ -978,9 +967,7 @@ module.exports = {
           (deps.size > 1 ? 'dependencies' : 'dependency') +
           ': ' +
           joinEnglish(
-            Array.from(deps)
-              .sort()
-              .map(name => "'" + formatDependency(name) + "'")
+            [...deps].sort().map(name => "'" + formatDependency(name) + "'")
           ) +
           `. Either ${fixVerb} ${
             deps.size > 1 ? 'them' : 'it'
@@ -991,7 +978,7 @@ module.exports = {
       let extraWarning = '';
       if (unnecessaryDependencies.size > 0) {
         let badRef = null;
-        Array.from(unnecessaryDependencies.keys()).forEach(key => {
+        [...unnecessaryDependencies.keys()].forEach(key => {
           if (badRef != null) {
             return;
           }
@@ -1004,7 +991,7 @@ module.exports = {
             ` Mutable values like '${badRef}' aren't valid dependencies ` +
             "because mutating them doesn't re-render the component.";
         } else if (externalDependencies.size > 0) {
-          const dep = Array.from(externalDependencies)[0];
+          const dep = [...externalDependencies][0];
           // Don't show this warning for things that likely just got moved *inside* the callback
           // because in that case they're clearly not referring to globals.
           if (!scope.set.has(dep)) {
@@ -1028,8 +1015,7 @@ module.exports = {
           return;
         }
         let isPropsOnlyUsedInMembers = true;
-        for (let i = 0; i < refs.length; i++) {
-          const ref = refs[i];
+        for (const ref of refs) {
           const id = fastFindReferenceWithParent(
             componentScope.block,
             ref.identifier
@@ -1121,8 +1107,8 @@ module.exports = {
           const references = usedDep.references;
           let id;
           let maybeCall;
-          for (let i = 0; i < references.length; i++) {
-            id = references[i].identifier;
+          for (const reference of references) {
+            id = reference.identifier;
             maybeCall = id.parent;
             // Try to see if we have setState(someExpr(missingDep)).
             while (maybeCall != null && maybeCall !== componentScope.block) {
@@ -1146,7 +1132,7 @@ module.exports = {
                       form: 'reducer'
                     };
                   } else {
-                    const resolved = references[i].resolved;
+                    const resolved = reference.resolved;
                     if (resolved != null) {
                       // If it's a parameter *and* a missing dep,
                       // it must be a prop or something inside a prop.
@@ -1189,7 +1175,7 @@ module.exports = {
             case 'updater':
               extraWarning = ` You can also do a functional update '${
                 setStateRecommendation.setter
-              }(${setStateRecommendation.missingDep.substring(
+              }(${setStateRecommendation.missingDep.slice(
                 0,
                 1
               )} => ...)' if you only need '${
@@ -1224,13 +1210,13 @@ module.exports = {
         suggest: [
           {
             desc: `Update the dependencies array to be: [${suggestedDeps
-              .map(formatDependency)
+              .map(element => formatDependency(element))
               .join(', ')}]`,
             fix(fixer) {
               // TODO: consider preserving the comments or formatting?
               return fixer.replaceText(
                 declaredDependenciesNode,
-                `[${suggestedDeps.map(formatDependency).join(', ')}]`
+                `[${suggestedDeps.map(element => formatDependency(element)).join(', ')}]`
               );
             }
           }
@@ -1520,7 +1506,7 @@ function collectRecommendations({
   declaredDependencies.forEach(({ key }) => {
     // Does this declared dep satisfy a real need?
     if (satisfyingDependencies.has(key)) {
-      if (suggestedDependencies.indexOf(key) === -1) {
+      if (!suggestedDependencies.includes(key)) {
         // Good one.
         suggestedDependencies.push(key);
       } else {
@@ -1536,7 +1522,7 @@ function collectRecommendations({
       // Such as resetting scroll when ID changes.
       // Consider them legit.
       // The exception is ref.current which is always wrong.
-      if (suggestedDependencies.indexOf(key) === -1) {
+      if (!suggestedDependencies.includes(key)) {
         suggestedDependencies.push(key);
       }
     } else {
@@ -1681,12 +1667,12 @@ function scanForConstructions({
       while (currentScope !== scope && currentScope != null) {
         currentScope = currentScope.upper;
       }
-      if (currentScope !== scope) {
-        // This reference is outside the Hook callback.
+      if (
+        currentScope !== scope && // This reference is outside the Hook callback.
         // It can only be legit if it's the deps array.
-        if (!isAncestorNodeOf(declaredDependenciesNode, reference.identifier)) {
-          return true;
-        }
+        !isAncestorNodeOf(declaredDependenciesNode, reference.identifier)
+      ) {
+        return true;
       }
     }
     return false;
@@ -1837,11 +1823,11 @@ function getReactiveHookCallbackIndex(calleeNode, options) {
         let name;
         try {
           name = analyzePropertyChain(node, null);
-        } catch (error) {
-          if (/Unsupported node type/.test(error.message)) {
+        } catch (err) {
+          if (/Unsupported node type/.test(err.message)) {
             return 0;
           }
-          throw error;
+          throw err;
         }
         return options.additionalHooks.test(name) ? 0 : -1;
       }
@@ -1863,7 +1849,7 @@ function fastFindReferenceWithParent(start, target) {
   const queue = [start];
   let item = null;
 
-  while (queue.length) {
+  while (queue.length > 0) {
     item = queue.shift();
 
     if (isSameIdentifier(item, target)) {
@@ -1882,7 +1868,7 @@ function fastFindReferenceWithParent(start, target) {
         value.parent = item;
         queue.push(value);
       } else if (Array.isArray(value)) {
-        // eslint-disable-next-line no-loop-func
+        // eslint-disable-next-line no-loop-func -- FIXME
         value.forEach(val => {
           if (isNodeLike(val)) {
             val.parent = item;

package/lib/rules/react/prefer-named-property-access.js

@@ -40,7 +40,7 @@ function* updateImportStatement(context, fixer, key) {
   }
 
   // Named imports section is present and current key is not imported yet - add it to named imports section
-  yield fixer.insertTextAfter(importNode.specifiers.slice().pop(), `, ${key}`);
+  yield fixer.insertTextAfter([...importNode.specifiers].pop(), `, ${key}`);
 }
 
 /** @type {import('eslint').Rule.RuleModule} */

package/lib/rules/tss/class-naming.js

@@ -9,7 +9,7 @@ module.exports = {
       CallExpression(node) {
         const stylesObj = getStyesObj(node);
 
-        if (typeof stylesObj === 'undefined') {
+        if (stylesObj === undefined) {
           return;
         }
 

package/lib/rules/tss/no-color-value.js

@@ -25,7 +25,6 @@ module.exports = {
         function checkColorLiteral(value) {
           if (value.type === 'Literal' && typeof value.value === 'string') {
             const colorCodePattern =
-              // eslint-disable-next-line max-len
               /#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})|rgb\?\(\s*(\d{1,3}\s*,\s*){2}\d{1,3}(?:\s*,\s*\d*(?:\.\d+)?)?\s*\)/g;
             const isColorCode = colorCodePattern.test(value.value);
             if (isColorCode) {

package/lib/rules/tss/unused-classes.js

@@ -12,7 +12,7 @@ module.exports = {
       CallExpression(node) {
         const stylesObj = getStyesObj(node);
 
-        if (typeof stylesObj === 'undefined') {
+        if (stylesObj === undefined) {
           return;
         }
 

package/lib/util/intl.js

@@ -9,13 +9,13 @@ function findFormatMessageAttrNode(node, attrName) {
   // Find formatMessage usages
   if (
     node.type === 'CallExpression' &&
-    (node.callee.name === 'formatMessage' || node.callee.name === '$t')
+    (node.callee.name === 'formatMessage' || node.callee.name === '$t') &&
+    node.arguments.length > 0 &&
+    node.arguments[0].properties
   ) {
-    if (node.arguments.length && node.arguments[0].properties) {
-      return node.arguments[0].properties.find(
-        a => a.key && a.key.name === attrName
-      );
-    }
+    return node.arguments[0].properties.find(
+      a => a.key && a.key.name === attrName
+    );
   }
 
   // Find intl.formatMessage usages

package/lib/util/translations.js

@@ -1,7 +1,6 @@
-/* eslint-disable no-sync */
-const fs = require('fs');
-const path = require('path');
-const { tsImport } = require('./import');
+const fs = require('node:fs');
+const path = require('node:path');
+const { tsImport } = require('@agilebot/eslint-utils');
 const { getSetting } = require('./settings');
 
 /**

package/lib/util/tss.js

@@ -12,7 +12,7 @@ function getBasicIdentifier(node) {
 
   if (node.type === 'TemplateLiteral') {
     // Handle template literals, e.g., classes[`foo`]
-    if (node.expressions.length) {
+    if (node.expressions.length > 0) {
       // Template literals with expressions, e.g., classes[`foo${bar}`]
       return null;
     }
@@ -25,12 +25,17 @@ function getBasicIdentifier(node) {
 
 // Helper function to recursively get the base identifier from a MemberExpression node
 function getBaseIdentifier(node) {
-  if (node.type === 'Identifier') {
-    return node;
-  } else if (node.type === 'CallExpression') {
-    return getBaseIdentifier(node.callee);
-  } else if (node.type === 'MemberExpression') {
-    return getBaseIdentifier(node.object);
+  switch (node.type) {
+    case 'Identifier': {
+      return node;
+    }
+    case 'CallExpression': {
+      return getBaseIdentifier(node.callee);
+    }
+    case 'MemberExpression': {
+      return getBaseIdentifier(node.object);
+    }
+    // No default
   }
   return null;
 }

package/package.json

@@ -1,21 +1,27 @@
 {
   "name": "@agilebot/eslint-plugin",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Agilebot's ESLint plugin",
   "main": "lib",
   "license": "MIT",
+  "keywords": [
+    "eslint",
+    "eslint-plugin"
+  ],
   "repository": {
     "url": "sh-agilebot/frontend-toolkit",
     "directory": "packages/eslint-plugin"
   },
   "homepage": "https://github.com/sh-agilebot/frontend-toolkit/tree/master/packages/eslint-plugin#readme",
+  "engines": {
+    "node": "^18.18.0 || >=20.0.0"
+  },
   "dependencies": {
     "@typescript-eslint/utils": "^7.1.1",
-    "consola": "^3.2.3",
-    "fast-glob": "^3.3.2",
-    "get-tsconfig": "^4.7.3",
-    "jiti": "^1.21.0",
-    "sucrase": "^3.35.0"
+    "fast-glob": "^3.3.2"
+  },
+  "peerDependencies": {
+    "eslint": "^7.0.0 || ^8.0.0"
   },
   "files": [
     "lib"

package/lib/util/import.js

@@ -1,71 +0,0 @@
-const path = require('path');
-const jiti = require('jiti');
-const { transform } = require('sucrase');
-const { getTsconfig } = require('get-tsconfig');
-
-/**
- * import ts module, like require, but support ts
- * @param {*} modulePath - module path
- */
-function tsImport(modulePath) {
-  if (!modulePath) {
-    return;
-  }
-  /** try to delete cache first */
-  try {
-    if (require.cache[modulePath]) {
-      delete require.cache[modulePath];
-    }
-  } catch (err) {
-    /* empty */
-  }
-
-  try {
-    return require(modulePath);
-  } catch (err) {
-    const tsconfig = getTsconfig(modulePath);
-    const { paths, baseUrl } = tsconfig.config.compilerOptions;
-    let basePath = path.dirname(tsconfig.path);
-    basePath = path.resolve(basePath, baseUrl);
-
-    const alias = resolveTsconfigPathsToAlias(paths, basePath);
-
-    return jiti(__filename, {
-      interopDefault: true,
-      cache: false,
-      debug: !!process.env.DEBUG,
-      transform: options => {
-        return transform(options.source, {
-          transforms: ['imports', 'typescript']
-        });
-      },
-      alias
-    })(modulePath);
-  }
-}
-
-/**
- * Resolve tsconfig.json paths to Webpack aliases
- * @param  {string} paths     - tsconfig.json paths
- * @param  {string} basePath  - Path from tsconfig to Webpack config to create absolute aliases
- * @return {object}           - Webpack alias config
- */
-function resolveTsconfigPathsToAlias(paths, basePath = __dirname) {
-  const aliases = {};
-
-  Object.keys(paths).forEach(item => {
-    const key = item.replace('/*', '');
-    const value = path.resolve(
-      basePath,
-      paths[item][0].replace('/*', '').replace('*', '')
-    );
-
-    aliases[key] = value;
-  });
-
-  return aliases;
-}
-
-module.exports = {
-  tsImport
-};