@checkdigit/eslint-plugin 6.6.0-PR.75-0fc6 → 6.6.0-PR.75-c9a3

package/src/agent/no-unused-imports.ts

@@ -0,0 +1,102 @@
+// agent/no-unused-imports.ts
+
+/*
+ * Copyright (c) 2021-2024 Check Digit, LLC
+ *
+ * This code is licensed under the MIT license (see LICENSE.txt for details).
+ */
+
+import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';
+import type { Scope } from '@typescript-eslint/utils/ts-eslint';
+import getDocumentationUrl from '../get-documentation-url';
+
+export const ruleId = 'no-unused-imports';
+
+const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
+
+const rule = createRule({
+  name: ruleId,
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'Remove unused imports.',
+    },
+    messages: {
+      removeUnusedImports: 'Removing unused imports.',
+      unknownError: 'Unknown error occurred in file "{{fileName}}": {{ error }}.',
+    },
+    fixable: 'code',
+    schema: [],
+  },
+  defaultOptions: [],
+  create(context) {
+    const sourceCode = context.sourceCode;
+
+    function isImportUsed(specifier: TSESTree.ImportClause, scope: Scope.Scope): boolean {
+      return (
+        specifier.type !== TSESTree.AST_NODE_TYPES.ImportSpecifier ||
+        scope.references.some((ref) => ref.identifier.name === specifier.local.name) ||
+        scope.childScopes.some((childScope) => isImportUsed(specifier, childScope))
+      );
+    }
+
+    return {
+      ImportDeclaration(importDeclaration) {
+        try {
+          const moduleName = importDeclaration.source.value;
+          if (
+            !importDeclaration.specifiers.every(
+              (specifier) => specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier,
+            ) ||
+            // [TODO:] move to meta schema
+            !['@checkdigit/serve-runtime', '@checkdigit/fixture'].includes(moduleName)
+          ) {
+            return;
+          }
+
+          const originalSpecifiers = importDeclaration.specifiers;
+          const scope = sourceCode.getScope(importDeclaration);
+          const usedSpecifiers = originalSpecifiers.filter((specifier) => isImportUsed(specifier, scope));
+          if (usedSpecifiers.length === originalSpecifiers.length) {
+            return;
+          }
+
+          if (usedSpecifiers.length === 0) {
+            context.report({
+              messageId: 'removeUnusedImports',
+              node: importDeclaration,
+              *fix(fixer) {
+                yield fixer.remove(importDeclaration);
+              },
+            });
+            return;
+          }
+
+          const usedSpecifierTexts = usedSpecifiers.map((specifier) => sourceCode.getText(specifier));
+          const updatedImportDeclaration = `import ${importDeclaration.importKind === 'type' ? 'type ' : ''}{ ${usedSpecifierTexts.join(', ')} } from '${moduleName}';`;
+
+          context.report({
+            messageId: 'removeUnusedImports',
+            node: importDeclaration,
+            *fix(fixer) {
+              yield fixer.replaceText(importDeclaration, updatedImportDeclaration);
+            },
+          });
+        } catch (error) {
+          // eslint-disable-next-line no-console
+          console.error(`Failed to apply ${ruleId} rule for file "${context.filename}":`, error);
+          context.report({
+            node: importDeclaration,
+            messageId: 'unknownError',
+            data: {
+              fileName: context.filename,
+              error: error instanceof Error ? error.toString() : JSON.stringify(error),
+            },
+          });
+        }
+      },
+    };
+  },
+});
+
+export default rule;

package/src/index.ts

@@ -12,6 +12,9 @@ import fetchResponseHeaderGetter, {
   ruleId as fetchResponseHeaderGetterRuleId,
 } from './agent/fetch-response-header-getter';
 import fetchThen, { ruleId as fetchThenRuleId } from './agent/fetch-then';
+import fixFunctionCallArguments, {
+  ruleId as fixFunctionCallArgumentsRuleId,
+} from './agent/fix-function-call-arguments';
 import invalidJsonStringify, { ruleId as invalidJsonStringifyRuleId } from './invalid-json-stringify';
 import noDuplicatedImports, { ruleId as noDuplicatedImportsRuleId } from './no-duplicated-imports';
 import noFixture, { ruleId as noFixtureRuleId } from './agent/no-fixture';
@@ -23,6 +26,7 @@ import noStatusCode, { ruleId as noStatusCodeRuleId } from './agent/no-status-co
 import noUnusedFunctionArguments, {
   ruleId as noUnusedFunctionArgumentsRuleId,
 } from './agent/no-unused-function-argument';
+import noUnusedImports, { ruleId as noUnusedImportsRuleId } from './agent/no-unused-imports';
 import noUnusedServiceVariables, { ruleId as noUnusedServiceVariablesRuleId } from './agent/no-unused-service-variable';
 import requireFixedServicesImport, {
   ruleId as requireFixedServicesImportRuleId,
@@ -71,6 +75,8 @@ export default {
     [requireTypeOutOfTypeOnlyImportsRuleId]: requireTypeOutOfTypeOnlyImports,
     [noUnusedFunctionArgumentsRuleId]: noUnusedFunctionArguments,
     [noUnusedServiceVariablesRuleId]: noUnusedServiceVariables,
+    [noUnusedImportsRuleId]: noUnusedImports,
+    [fixFunctionCallArgumentsRuleId]: fixFunctionCallArguments,
   },
   configs: {
     all: {
@@ -125,6 +131,8 @@ export default {
         [`@checkdigit/${fetchThenRuleId}`]: 'error',
         [`@checkdigit/${noUnusedFunctionArgumentsRuleId}`]: 'error',
         [`@checkdigit/${noUnusedServiceVariablesRuleId}`]: 'error',
+        [`@checkdigit/${noUnusedImportsRuleId}`]: 'error',
+        [`@checkdigit/${fixFunctionCallArgumentsRuleId}`]: 'error',
       },
     },
     'agent-phase-2-production': {
@@ -140,6 +148,8 @@ export default {
         [`@checkdigit/${fetchThenRuleId}`]: 'error',
         [`@checkdigit/${noUnusedFunctionArgumentsRuleId}`]: 'error',
         [`@checkdigit/${noUnusedServiceVariablesRuleId}`]: 'error',
+        [`@checkdigit/${noUnusedImportsRuleId}`]: 'error',
+        [`@checkdigit/${fixFunctionCallArgumentsRuleId}`]: 'error',
       },
     },
   },