@checkdigit/eslint-plugin 7.17.1 → 8.0.0-PR.141-56ee

package/dist-types/no-legacy-service-typing.d.ts

@@ -1,5 +1,7 @@
 import { ESLintUtils } from '@typescript-eslint/utils';
 export declare const ruleId = "no-legacy-service-typing";
 declare const DISALLOWED_SERVICE_TYPINGS: string[] | undefined;
-declare const rule: ESLintUtils.RuleModule<'noLegacyServiceTyping', [typeof DISALLOWED_SERVICE_TYPINGS]>;
+declare const rule: ESLintUtils.RuleModule<'noLegacyServiceTyping', [
+    typeof DISALLOWED_SERVICE_TYPINGS
+]>;
 export default rule;

package/package.json

@@ -1,96 +1 @@
-{
-  "name": "@checkdigit/eslint-plugin",
-  "version": "7.17.1",
-  "description": "Check Digit eslint plugins",
-  "keywords": [
-    "eslint",
-    "eslintplugin"
-  ],
-  "homepage": "https://github.com/checkdigit/eslint-plugin#readme",
-  "bugs": {
-    "url": "https://github.com/checkdigit/eslint-plugin/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/checkdigit/eslint-plugin"
-  },
-  "license": "MIT",
-  "author": "Check Digit, LLC",
-  "sideEffects": false,
-  "type": "module",
-  "exports": {
-    ".": {
-      "types": "./dist-types/index.d.ts",
-      "import": "./dist-mjs/index.mjs",
-      "default": "./dist-mjs/index.mjs"
-    }
-  },
-  "files": [
-    "src",
-    "dist-types",
-    "dist-mjs",
-    "!src/**/test/**",
-    "!src/**/*.test.ts",
-    "!src/**/*.spec.ts",
-    "!dist-types/**/test/**",
-    "!dist-types/**/*.test.d.ts",
-    "!dist-types/**/*.spec.d.ts",
-    "!dist-mjs/**/test/**",
-    "!dist-mjs/**/*.test.mjs",
-    "!dist-mjs/**/*.spec.mjs",
-    "SECURITY.md"
-  ],
-  "scripts": {
-    "build:dist-mjs": "rimraf dist-mjs && npx builder --type=module --sourceMap --outDir=dist-mjs && node dist-mjs/index.mjs",
-    "build:dist-types": "rimraf dist-types && npx builder --type=types --outDir=dist-types",
-    "ci:compile": "tsc --noEmit",
-    "ci:coverage": "NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=true",
-    "ci:lint": "npm run lint",
-    "ci:style": "npm run prettier",
-    "ci:test": "NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=false",
-    "lint": "eslint --max-warnings 0 .",
-    "lint:fix": "eslint --max-warnings 0 --fix .",
-    "prepare": "",
-    "prepublishOnly": "npm run build:dist-types && npm run build:dist-mjs",
-    "prettier": "prettier --ignore-path .gitignore --list-different .",
-    "prettier:fix": "prettier --ignore-path .gitignore --write .",
-    "test": "npm run ci:compile && npm run ci:test && npm run ci:lint && npm run ci:style"
-  },
-  "prettier": "@checkdigit/prettier-config",
-  "jest": {
-    "preset": "@checkdigit/jest-config"
-  },
-  "dependencies": {
-    "@typescript-eslint/type-utils": "^8.46.0",
-    "@typescript-eslint/utils": "^8.46.0",
-    "http-status-codes": "^2.3.0",
-    "ts-api-utils": "^2.1.0"
-  },
-  "devDependencies": {
-    "@checkdigit/jest-config": "^6.0.2",
-    "@checkdigit/prettier-config": "^6.1.0",
-    "@checkdigit/typescript-config": "^9.3.2",
-    "@eslint/js": "^9.37.0",
-    "@types/eslint": "^9.6.1",
-    "@types/eslint-config-prettier": "^6.11.3",
-    "@typescript-eslint/parser": "^8.46.0",
-    "@typescript-eslint/rule-tester": "^8.46.0",
-    "eslint": "^9.37.0",
-    "eslint-config-prettier": "^10.1.8",
-    "eslint-import-resolver-typescript": "^4.4.4",
-    "eslint-plugin-eslint-plugin": "^6.4.0",
-    "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-no-only-tests": "^3.3.0",
-    "eslint-plugin-no-secrets": "^2.2.1",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-sonarjs": "1.0.4",
-    "rimraf": "^6.0.1",
-    "typescript-eslint": "^8.46.0"
-  },
-  "peerDependencies": {
-    "eslint": ">=9 <10"
-  },
-  "engines": {
-    "node": ">=22.18"
-  }
-}
+{"name":"@checkdigit/eslint-plugin","version":"8.0.0-PR.141-56ee","description":"Check Digit eslint plugins","keywords":["eslint","eslintplugin"],"homepage":"https://github.com/checkdigit/eslint-plugin#readme","bugs":{"url":"https://github.com/checkdigit/eslint-plugin/issues"},"repository":{"type":"git","url":"https://github.com/checkdigit/eslint-plugin"},"license":"MIT","author":"Check Digit, LLC","sideEffects":false,"type":"module","exports":{".":{"types":"./dist-types/index.d.ts","import":"./dist-mjs/index.mjs","default":"./dist-mjs/index.mjs"}},"files":["src","dist-types","dist-mjs","!src/**/test/**","!src/**/*.test.ts","!src/**/*.spec.ts","!dist-types/**/test/**","!dist-types/**/*.test.d.ts","!dist-types/**/*.spec.d.ts","!dist-mjs/**/test/**","!dist-mjs/**/*.test.mjs","!dist-mjs/**/*.spec.mjs","SECURITY.md"],"scripts":{"build:dist-mjs":"rimraf dist-mjs && npx builder --type=module --sourceMap --outDir=dist-mjs && node dist-mjs/index.mjs","build:dist-types":"rimraf dist-types && npx builder --type=types --outDir=dist-types","ci:compile":"tsc --noEmit","ci:coverage":"rimraf coverage && mkdir coverage && node --disable-warning ExperimentalWarning --experimental-strip-types --experimental-test-module-mocks --test-timeout 600000 --experimental-test-coverage --test-reporter=lcov --test-reporter-destination=coverage/lcov.info --test-reporter spec --test-reporter-destination stdout --test \"src/**/*.spec.ts\"","ci:lint":"npm run lint","ci:style":"npm run prettier","ci:test":"node --disable-warning=ExperimentalWarning --experimental-strip-types --experimental-test-module-mocks --test-timeout 600000 --test \"src/**/*.spec.ts\"","lint":"eslint --max-warnings 0 . --ignore-pattern '**/rule-tester.test.ts'","lint:fix":"eslint --max-warnings 0 --fix . --ignore-pattern '**/rule-tester.test.ts'","prepare":"","prepublishOnly":"npm run build:dist-types && npm run build:dist-mjs","prettier":"prettier --ignore-path .gitignore --list-different .","prettier:fix":"prettier --ignore-path .gitignore --write .","test":"npm run ci:compile && npm run ci:test && npm run ci:lint && npm run ci:style"},"prettier":"@checkdigit/prettier-config","dependencies":{"@typescript-eslint/type-utils":"^8.57.2","@typescript-eslint/utils":"^8.57.2","http-status-codes":"^2.3.0","ts-api-utils":"^2.5.0"},"devDependencies":{"@checkdigit/prettier-config":"^8.0.0","@checkdigit/typescript-config":"^10.0.1","@eslint/js":"^10.0.1","@types/eslint":"^9.6.1","@types/eslint-config-prettier":"^6.11.3","@typescript-eslint/parser":"^8.57.2","@typescript-eslint/rule-tester":"^8.57.2","eslint":"^10.1.0","eslint-config-prettier":"^10.1.8","eslint-import-resolver-typescript":"^4.4.4","eslint-plugin-eslint-plugin":"^7.3.2","eslint-plugin-no-only-tests":"^3.3.0","eslint-plugin-no-secrets":"^2.3.3","eslint-plugin-node":"^11.1.0","eslint-plugin-sonarjs":"4.0.2","rimraf":"^6.1.3","typescript-eslint":"^8.57.2"},"peerDependencies":{"eslint":">=10 <11"},"engines":{"node":">=24.13"}}

package/src/aws/is-aws-sdk-v3-used.ts

@@ -16,9 +16,13 @@ export default async function isAwsSdkV3Used(): Promise<boolean> {
     return cachedIsAwsSdkV3Used;
   }
 
-  const packageJson = JSON.parse(await fs.readFile('package.json', 'utf8')) as PackageJson;
+  const packageJson = JSON.parse(
+    await fs.readFile('package.json', 'utf8'),
+  ) as PackageJson;
   const dependencies = packageJson.dependencies ?? {};
   // eslint-disable-next-line require-atomic-updates
-  cachedIsAwsSdkV3Used = Object.keys(dependencies).some((dependency) => dependency.startsWith('@aws-sdk/'));
+  cachedIsAwsSdkV3Used = Object.keys(dependencies).some((dependency) =>
+    dependency.startsWith('@aws-sdk/'),
+  );
   return cachedIsAwsSdkV3Used;
 }

package/src/aws/require-aws-bare-bones.ts

@@ -1,20 +1,41 @@
 // require-aws-bare-bones.ts
 
-import { AST_NODE_TYPES, ESLintUtils, TSESTree } from '@typescript-eslint/utils';
+import {
+  AST_NODE_TYPES,
+  ESLintUtils,
+  TSESTree,
+} from '@typescript-eslint/utils';
 import getDocumentationUrl from '../get-documentation-url.ts';
 
 export const ruleId = 'require-aws-bare-bones';
 export const MESSAGE_ID_AGGREGATED_CLIENT = 'noAggregatedClient';
 
-const BARE_BONES_SUFFIXES = ['Client', 'Command', 'Exception', 'Input', 'Output'];
-const AWS_LIB_AGGREGATED_SUFFIXES = ['Document', 'Paginator', 'Utils', 'Service', 'Collection', 'Manager'];
+const BARE_BONES_SUFFIXES = [
+  'Client',
+  'Command',
+  'Exception',
+  'Input',
+  'Output',
+];
+const AWS_LIB_AGGREGATED_SUFFIXES = [
+  'Document',
+  'Paginator',
+  'Utils',
+  'Service',
+  'Collection',
+  'Manager',
+];
 const AWS_SDK_CLIENT = '@aws-sdk/client-';
 const AWS_SDK_LIB = '@aws-sdk/lib-';
 
 const createRule = ESLintUtils.RuleCreator(getDocumentationUrl);
 
-const isAwsSdkClientModule = ({ source }: TSESTree.ImportDeclaration): boolean =>
-  typeof source.value === 'string' && (source.value.startsWith(AWS_SDK_CLIENT) || source.value.startsWith(AWS_SDK_LIB));
+const isAwsSdkClientModule = ({
+  source,
+}: TSESTree.ImportDeclaration): boolean =>
+  typeof source.value === 'string' &&
+  (source.value.startsWith(AWS_SDK_CLIENT) ||
+    source.value.startsWith(AWS_SDK_LIB));
 
 const kebabToPascal = (str: string): string =>
   str
@@ -39,51 +60,53 @@ const isAggregatedClient = (name: string, importSource: string): boolean => {
     const pkg = importSource.replace(AWS_SDK_LIB, '');
     const pkgPascal = kebabToPascal(pkg);
     return (
-      (name.startsWith(pkgPascal) && !endsWithAnySuffix(name, BARE_BONES_SUFFIXES)) ||
+      (name.startsWith(pkgPascal) &&
+        !endsWithAnySuffix(name, BARE_BONES_SUFFIXES)) ||
       endsWithAnySuffix(name, AWS_LIB_AGGREGATED_SUFFIXES)
     );
   }
   return false;
 };
 
-const rule: ESLintUtils.RuleModule<typeof MESSAGE_ID_AGGREGATED_CLIENT> = createRule({
-  name: ruleId,
-  meta: {
-    type: 'problem',
-    docs: {
-      description:
-        'Disallow importing aggregated AWS SDK v3 clients. Use bare-bones pattern (Client/Lib plus Command) for better tree-shaking.',
-    },
-    messages: {
-      [MESSAGE_ID_AGGREGATED_CLIENT]:
-        'Do not import aggregated AWS SDK v3 client "{{clientName}}". Use bare-bones pattern ({{clientName}}Client/Lib plus Command) instead.',
+const rule: ESLintUtils.RuleModule<typeof MESSAGE_ID_AGGREGATED_CLIENT> =
+  createRule({
+    name: ruleId,
+    meta: {
+      type: 'problem',
+      docs: {
+        description:
+          'Disallow importing aggregated AWS SDK v3 clients. Use bare-bones pattern (Client/Lib plus Command) for better tree-shaking.',
+      },
+      messages: {
+        [MESSAGE_ID_AGGREGATED_CLIENT]:
+          'Do not import aggregated AWS SDK v3 client "{{clientName}}". Use bare-bones pattern ({{clientName}}Client/Lib plus Command) instead.',
+      },
+      schema: [],
     },
-    schema: [],
-  },
-  defaultOptions: [],
-  create(context) {
-    return {
-      ImportDeclaration(node) {
-        if (node.importKind === 'type' || !isAwsSdkClientModule(node)) {
-          return;
-        }
+    defaultOptions: [],
+    create(context) {
+      return {
+        ImportDeclaration(node) {
+          if (node.importKind === 'type' || !isAwsSdkClientModule(node)) {
+            return;
+          }
 
-        for (const specifier of node.specifiers) {
-          if (
-            specifier.type === AST_NODE_TYPES.ImportSpecifier &&
-            specifier.importKind !== 'type' &&
-            isAggregatedClient(specifier.local.name, node.source.value)
-          ) {
-            context.report({
-              node: specifier,
-              messageId: MESSAGE_ID_AGGREGATED_CLIENT,
-              data: { clientName: specifier.local.name },
-            });
+          for (const specifier of node.specifiers) {
+            if (
+              specifier.type === AST_NODE_TYPES.ImportSpecifier &&
+              specifier.importKind !== 'type' &&
+              isAggregatedClient(specifier.local.name, node.source.value)
+            ) {
+              context.report({
+                node: specifier,
+                messageId: MESSAGE_ID_AGGREGATED_CLIENT,
+                data: { clientName: specifier.local.name },
+              });
+            }
           }
-        }
-      },
-    };
-  },
-});
+        },
+      };
+    },
+  });
 
 export default rule;

package/src/aws/require-aws-config.ts

@@ -6,7 +6,11 @@
  * This code is licensed under the MIT license (see LICENSE.txt for details).
  */
 
-import { AST_NODE_TYPES, ESLintUtils, TSESTree } from '@typescript-eslint/utils';
+import {
+  AST_NODE_TYPES,
+  ESLintUtils,
+  TSESTree,
+} from '@typescript-eslint/utils';
 import getDocumentationUrl from '../get-documentation-url.ts';
 
 export const ruleId = 'require-aws-config';
@@ -14,92 +18,110 @@ export const MESSAGE_ID_REQUIRE_AWS_CONFIG = 'requireAwsConfig';
 export const MESSAGE_ID_NO_CHECKDIGIT_AWS = 'noCheckdigitAws';
 const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
 
-function isAwsSdkClientModule(importDeclaration: TSESTree.ImportDeclaration): boolean {
+function isAwsSdkClientModule(
+  importDeclaration: TSESTree.ImportDeclaration,
+): boolean {
   return importDeclaration.source.value.startsWith('@aws-sdk/client-');
 }
 
-function isCheckdigitAwsModule(importDeclaration: TSESTree.ImportDeclaration): boolean {
+function isCheckdigitAwsModule(
+  importDeclaration: TSESTree.ImportDeclaration,
+): boolean {
   return importDeclaration.source.value === '@checkdigit/aws';
 }
 
-function isAwsClient(awsClientName: string, importedAwsClients?: Set<string>): boolean {
+function isAwsClient(
+  awsClientName: string,
+  importedAwsClients?: Set<string>,
+): boolean {
   // for simplicity, just check if it ends with 'Client'
   // we can consider type checking in the future if needed to verify if it actually extends from AWS SDK's Smithy Client class
   return (
-    awsClientName.endsWith('Client') && (importedAwsClients === undefined || importedAwsClients.has(awsClientName))
+    awsClientName.endsWith('Client') &&
+    (importedAwsClients === undefined || importedAwsClients.has(awsClientName))
   );
 }
 
-const rule: ESLintUtils.RuleModule<typeof MESSAGE_ID_REQUIRE_AWS_CONFIG | typeof MESSAGE_ID_NO_CHECKDIGIT_AWS> =
-  createRule({
-    name: ruleId,
-    meta: {
-      type: 'problem',
-      docs: {
-        description:
-          'Require applying @checkdigit/aws-config with qualifier/environment instead of creating new AWS client instance directly. Also disallow importing from deprecated @checkdigit/aws module.',
-      },
-      messages: {
-        [MESSAGE_ID_REQUIRE_AWS_CONFIG]:
-          'Please apply @checkdigit/aws-config with qualifier/environment instead of creating a new instance of {{awsClientName}} directly.',
-        [MESSAGE_ID_NO_CHECKDIGIT_AWS]:
-          'No longer import from deprecated module "@checkdigit/aws". Please migrate to the official AWS SDK v3 modules.',
-      },
-      schema: [],
+const rule: ESLintUtils.RuleModule<
+  typeof MESSAGE_ID_REQUIRE_AWS_CONFIG | typeof MESSAGE_ID_NO_CHECKDIGIT_AWS
+> = createRule({
+  name: ruleId,
+  meta: {
+    type: 'problem',
+    docs: {
+      description:
+        'Require applying @checkdigit/aws-config with qualifier/environment instead of creating new AWS client instance directly. Also disallow importing from deprecated @checkdigit/aws module.',
     },
-    defaultOptions: [],
-    create(context) {
-      const { isAwsSdkV3Used } = context.settings;
-      const importedAwsClients = new Set<string>();
+    messages: {
+      [MESSAGE_ID_REQUIRE_AWS_CONFIG]:
+        'Please apply @checkdigit/aws-config with qualifier/environment instead of creating a new instance of {{awsClientName}} directly.',
+      [MESSAGE_ID_NO_CHECKDIGIT_AWS]:
+        'No longer import from deprecated module "@checkdigit/aws". Please migrate to the official AWS SDK v3 modules.',
+    },
+    schema: [],
+  },
+  defaultOptions: [],
+  create(context) {
+    const { isAwsSdkV3Used } = context.settings;
+    const importedAwsClients = new Set<string>();
 
-      return {
-        ImportDeclaration(node) {
-          if (isAwsSdkV3Used !== true) {
-            return;
-          }
+    return {
+      ImportDeclaration(node) {
+        if (isAwsSdkV3Used !== true) {
+          return;
+        }
 
-          if (isCheckdigitAwsModule(node)) {
-            context.report({
-              node,
-              messageId: MESSAGE_ID_NO_CHECKDIGIT_AWS,
-            });
-            return;
-          }
+        if (isCheckdigitAwsModule(node)) {
+          context.report({
+            node,
+            messageId: MESSAGE_ID_NO_CHECKDIGIT_AWS,
+          });
+          return;
+        }
 
-          if (isAwsSdkClientModule(node)) {
-            for (const specifier of node.specifiers) {
-              if (specifier.type === AST_NODE_TYPES.ImportSpecifier && isAwsClient(specifier.local.name)) {
-                importedAwsClients.add(specifier.local.name);
-              }
+        if (isAwsSdkClientModule(node)) {
+          for (const specifier of node.specifiers) {
+            if (
+              specifier.type === AST_NODE_TYPES.ImportSpecifier &&
+              isAwsClient(specifier.local.name)
+            ) {
+              importedAwsClients.add(specifier.local.name);
             }
           }
-        },
+        }
+      },
 
-        NewExpression(node) {
-          if (isAwsSdkV3Used !== true) {
-            return;
-          }
+      NewExpression(node) {
+        if (isAwsSdkV3Used !== true) {
+          return;
+        }
 
-          if (node.callee.type === AST_NODE_TYPES.Identifier && isAwsClient(node.callee.name, importedAwsClients)) {
+        if (
+          node.callee.type === AST_NODE_TYPES.Identifier &&
+          isAwsClient(node.callee.name, importedAwsClients)
+        ) {
+          context.report({
+            node,
+            messageId: MESSAGE_ID_REQUIRE_AWS_CONFIG,
+            data: { awsClientName: node.callee.name },
+          });
+        } else if (node.callee.type === AST_NODE_TYPES.MemberExpression) {
+          // Handle `new AWS.DynamoDBClient()` style (MemberExpression)
+          const property = node.callee.property;
+          if (
+            property.type === AST_NODE_TYPES.Identifier &&
+            isAwsClient(property.name, importedAwsClients)
+          ) {
             context.report({
               node,
               messageId: MESSAGE_ID_REQUIRE_AWS_CONFIG,
-              data: { awsClientName: node.callee.name },
+              data: { awsClientName: property.name },
             });
-          } else if (node.callee.type === AST_NODE_TYPES.MemberExpression) {
-            // Handle `new AWS.DynamoDBClient()` style (MemberExpression)
-            const property = node.callee.property;
-            if (property.type === AST_NODE_TYPES.Identifier && isAwsClient(property.name, importedAwsClients)) {
-              context.report({
-                node,
-                messageId: MESSAGE_ID_REQUIRE_AWS_CONFIG,
-                data: { awsClientName: property.name },
-              });
-            }
           }
-        },
-      };
-    },
-  });
+        }
+      },
+    };
+  },
+});
 
 export default rule;