Added new rule 'require-aws-bare-bones' #137

jpolavar · 2025-10-07T17:45:11Z

Closes #135

Copilot

Pull Request Overview

This PR adds a new ESLint rule 'require-aws-bare-bones' that enforces the use of bare-bones AWS SDK v3 client patterns (Client + Command) instead of aggregated clients to improve tree-shaking and reduce bundle size.

Added a new ESLint rule that detects and prevents imports of aggregated AWS SDK v3 clients
Integrated the rule into the plugin's configuration and rule exports
Created comprehensive test coverage for valid and invalid usage patterns

Reviewed Changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/require-aws-bare-bones.ts	Implements the core rule logic to detect aggregated AWS SDK client imports
src/require-aws-bare-bones.spec.ts	Provides comprehensive test cases for both valid and invalid usage patterns
src/index.ts	Integrates the new rule into the plugin's rule registry and configurations
package.json	Updates version number to reflect the new rule addition
docs/rules/require-aws-bare-bones.md	Documents the rule with examples of correct and incorrect usage

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-07T17:45:36Z

docs/rules/require-aws-bare-bones.md

+import { DynamoDB } from '@aws-sdk/client-dynamodb';
+
+const ddb = new DynamoDB({});
+await ddb.putItem({});


The documentation shows incorrect 'Pass' example. This code imports the aggregated DynamoDB client which should fail according to the rule. It should be 'import { DynamoDBClient, PutItemCommand }' instead.

Suggested change

import { DynamoDB } from '@aws-sdk/client-dynamodb';

const ddb = new DynamoDB({});

await ddb.putItem({});

import { DynamoDBClient, PutItemCommand } from '@aws-sdk/client-dynamodb';

const ddb = new DynamoDBClient({});

await ddb.send(new PutItemCommand({}));

Copilot

Pull Request Overview

Copilot reviewed 6 out of 7 changed files in this pull request and generated 3 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-07T18:03:11Z

src/require-aws-bare-bones.ts

+// require-aws-bare-bones.ts
+
+import { AST_NODE_TYPES, ESLintUtils, TSESTree } from '@typescript-eslint/utils';
+import getDocumentationUrl from './get-documentation-url.ts';


The import statement includes a .ts extension which is not typically needed in TypeScript imports and may cause issues with module resolution in some environments.

Suggested change

import getDocumentationUrl from './get-documentation-url.ts';

import getDocumentationUrl from './get-documentation-url';

Copilot · 2025-10-07T18:03:11Z

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

+// require-aws-bare-bones.spec.ts
+
+import rule, { MESSAGE_ID_AGGREGATED_CLIENT, ruleId } from './require-aws-bare-bones.ts';
+import createTester from './ts-tester.test.ts';


The import statements include .ts extensions which are not typically needed in TypeScript imports and may cause issues with module resolution in some environments.

Suggested change

import createTester from './ts-tester.test.ts';

import createTester from './ts-tester.test';

Copilot · 2025-10-07T18:03:12Z

src/index.ts

  ruleId as requireServiceCallResponseDeclarationRuleId,
 } from './require-service-call-response-declaration.ts';
 import requireAwsConfig, { ruleId as requireAwsConfigRuleId } from './require-aws-config.ts';
+import requireAWSBareBones, { ruleId as requireAWSBareBonesRuleId } from './require-aws-bare-bones.ts';


The import statement includes a .ts extension which is not typically needed in TypeScript imports and may cause issues with module resolution in some environments.

We always use .ts extension targeting ESM output in TypeScript

Copilot

Pull Request Overview

Copilot reviewed 6 out of 7 changed files in this pull request and generated no new comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

jpolavar · 2025-10-07T19:03:13Z

Tested with internal services

carlansley

There is a merge conflict. Also, how does this relate to @le-cong's PR #134? No overlap?

jpolavar · 2025-10-14T21:51:17Z

There is a merge conflict. Also, how does this relate to @le-cong's PR #134? No overlap?

There should be no direct overlap: one is about import patterns, the other about configuration usage.
require-aws-bare-bones enforces using the bare-bones AWS SDK v3 pattern (Client + Command), preventing imports of aggregated clients.
require-aws-config likely enforces correct usage or presence of AWS SDK configuration (e.g., requiring explicit config when instantiating clients).

le-cong · 2025-10-15T16:41:30Z

.github/workflows/publish-beta.yml

+        run: npm install -g npm@11.4.2
      - name: Install Dependencies
-        run: npm ci --ignore-scripts
+        run: npm ci


is there a reason "--ignore-scripts" is removed?

publish beta fails Error: The package "@esbuild/linux-x64" could not be found, and is needed by esbuild. npm ci is allowing this binary to be installed

we were able to keep ignore-scripts in other repos though, are you sure that we have to remove it?

Rolled back this change

Copilot

Pull Request Overview

Copilot reviewed 9 out of 10 changed files in this pull request and generated 3 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-15T17:06:39Z

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

+    },
+    messages: {
+      [MESSAGE_ID_AGGREGATED_CLIENT]:
+        'Do not import aggregated AWS SDK v3 client "{{clientName}}". Use bare-bones pattern ({{clientName}}Client + Command) instead.',


The message assumes the bare-bones client name is always {{clientName}}Client, which is incorrect for services like StepFunctions (actual client is SFNClient). Rephrase to a generic instruction (e.g., 'Use the service-specific *Client class plus Command classes') or add logic to derive/display the correct client name for known exceptions.

Suggested change

'Do not import aggregated AWS SDK v3 client "{{clientName}}". Use bare-bones pattern ({{clientName}}Client + Command) instead.',

'Do not import aggregated AWS SDK v3 client "{{clientName}}". Use the service-specific *Client class plus Command classes instead.',

Copilot · 2025-10-15T17:06:39Z

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

+          const isException = specifier.local.name.endsWith('Exception');
+
+          if (
+            specifier.type === AST_NODE_TYPES.ImportSpecifier &&
+            !isTypeImport &&
+            !isException &&


The isException guard is redundant because names ending with 'Exception' already satisfy BARE_BONES_SUFFIXES and make isAggregatedClient return false. You can remove isException and its check to simplify the condition.

Suggested change

const isException = specifier.local.name.endsWith('Exception');

if (

specifier.type === AST_NODE_TYPES.ImportSpecifier &&

!isTypeImport &&

!isException &&

if (

specifier.type === AST_NODE_TYPES.ImportSpecifier &&

!isTypeImport &&

Copilot · 2025-10-15T17:06:40Z

docs/rules/require-aws-bare-bones.md

+# Enforce Bare-Bones AWS SDK v3 Client Usage
+
+Ensure that only bare-bones AWS SDK v3 clients and commands are imported and used. Importing and using aggregated clients (e.g., `S3`, `DynamoDB`) is disallowed to promote modularization and enable better tree-shaking for reduced bundle size.


[nitpick] Consider adding an example for a service where the bare-bones client name differs from the aggregated name (e.g., aggregated StepFunctions vs SFNClient) to clarify that the pattern is not always AggregatedName + Client.

le-cong · 2025-10-15T16:59:35Z

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

+
+function isAwsSdkClientModule(importDeclaration: TSESTree.ImportDeclaration): boolean {
+  return (
+    typeof importDeclaration.source.value === 'string' && importDeclaration.source.value.startsWith('@aws-sdk/client-')


should we handle document related stuff from "@aws-sdk/lib-*" as well? e.g. DynamoDBDocument from '@aws-sdk/lib-dynamodb'

le-cong · 2025-10-15T17:02:34Z

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

+
+        for (const specifier of node.specifiers) {
+          const isTypeImport = specifier.type === AST_NODE_TYPES.ImportSpecifier && specifier.importKind === 'type';
+          const isException = specifier.local.name.endsWith('Exception');


is it duplicated with the above regexp?

le-cong · 2025-10-15T17:27:43Z

.github/workflows/publish-beta.yml

+        run: npm install -g npm@11.4.2
      - name: Install Dependencies
-        run: npm ci --ignore-scripts
+        run: npm ci


we were able to keep ignore-scripts in other repos though, are you sure that we have to remove it?

Copilot

Pull Request Overview

Copilot reviewed 8 out of 9 changed files in this pull request and generated 5 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-15T23:14:20Z

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

+      [MESSAGE_ID_AGGREGATED_CLIENT]:
+        'Do not import aggregated AWS SDK v3 client "{{clientName}}". Use bare-bones pattern ({{clientName}}Client/ Lib plus Command) instead.',
+    },


The message suggests constructing {{clientName}}Client, which is incorrect for aggregated lib imports like DynamoDBDocument (correct base is DynamoDBClient). Also the fragment 'Client/ Lib' has an extra space and slash formatting issue. Recommend computing a baseClientName (derived from importSource) and changing the message to: 'Do not import aggregated AWS SDK v3 client "{{clientName}}". Use bare-bones pattern ({{baseClientName}}Client plus Command) instead.' Add baseClientName to data when reporting and remove the malformed 'Client/ Lib' formatting.

Copilot · 2025-10-15T23:14:21Z

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

+      code: `import { DynamoDBDocumentClient, PutCommand } from '@aws-sdk/lib-dynamodb';
+             import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
+             import awsConfig from '@checkdigit/aws-config';
+        const dynamo = awsConfig(DynamoDBClient, { qualifier, environment });
+        const dynamoDocument = DynamoDBDocument.from(dynamo);
+        await dynamoDocument.send(new PutCommand({ TableName: 'foo', Item: { id: 1 } }));`,


The snippet uses DynamoDBDocument.from but never imports DynamoDBDocument; instead it imports DynamoDBDocumentClient which is unused. This would produce an undefined reference. Replace DynamoDBDocumentClient with DynamoDBDocument in the import or change usage to DynamoDBDocumentClient.from if that API is intended.

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

docs/rules/require-aws-bare-bones.md

Copilot · 2025-10-15T23:14:22Z

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

+        '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.',


[nitpick] Description uses 'Client/Lib plus Command'; consider clarifying to 'Client (e.g., S3Client) plus specific Command(s)' to improve precision and remove the slash ambiguity.

Suggested change

'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.',

'Disallow importing aggregated AWS SDK v3 clients. Use bare-bones pattern (Client (e.g., S3Client) plus specific Command(s)) for better tree-shaking.',

},

messages: {

[MESSAGE_ID_AGGREGATED_CLIENT]:

'Do not import aggregated AWS SDK v3 client "{{clientName}}". Use bare-bones pattern ({{clientName}}Client (e.g., S3Client) plus specific Command(s)) instead.',

le-cong

just a minor comment

le-cong · 2025-10-15T23:58:59Z

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

+    return !endsWithAnySuffix(name, BARE_BONES_SUFFIXES);
+  }
+  if (importSource.startsWith(AWS_SDK_LIB)) {
+    const pkg = importSource.replace(AWS_SDK_LIB, '');


should BARE_BONES_SUFFIXES be checked for lib-* stuff as well?
btw the naming pattern matching for lib stuff feels a bit tricky, but hopefully it's good enough to cover what we normally use.

ya pretty much it should be good for the ones we use, else we can extend to have other usages as well

Copilot

Pull Request Overview

Copilot reviewed 8 out of 9 changed files in this pull request and generated 1 comment.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-16T14:58:02Z

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

+      code: `import { DynamoDBDocumentClient, PutCommand } from '@aws-sdk/lib-dynamodb';
+             import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
+             import awsConfig from '@checkdigit/aws-config';
+        const dynamo = awsConfig(DynamoDBClient, { qualifier, environment });
+        const dynamoDocument = DynamoDBDocument.from(dynamo);
+        await dynamoDocument.send(new PutCommand({ TableName: 'foo', Item: { id: 1 } }));`,


Uses DynamoDBDocument without importing it (only DynamoDBDocumentClient is imported); update import to include DynamoDBDocument or change usage to DynamoDBDocumentClient.from to avoid an unresolved identifier.

le-cong

hate to agree with some unsolved AI comments, otherwise lgtm

jpolavar · 2025-10-16T15:53:35Z

hate to agree with some unsolved AI comments, otherwise lgtm

some of them are outdated and others are mostly pointing to spec file

github-actions · 2025-10-16T16:10:51Z

Beta Published - Install Command: npm install @checkdigit/eslint-plugin@7.17.0-PR.137-b418

github-actions · 2025-10-16T16:12:28Z

❌ PR review status - has 1 reviewer outstanding

Added new rule 'require-aws-bare-bones'

aff70f9

jpolavar self-assigned this Oct 7, 2025

Copilot AI review requested due to automatic review settings October 7, 2025 17:45

jpolavar added the MINOR label Oct 7, 2025

Copilot AI reviewed Oct 7, 2025

View reviewed changes

jpolavar added 2 commits October 7, 2025 12:48

Updated documentation

cc22bb7

Pinned npm version in publish beta

19b2bdf

Copilot AI review requested due to automatic review settings October 7, 2025 18:02

Copilot AI reviewed Oct 7, 2025

View reviewed changes

Pinned npm version in publish beta

8931b7a

jpolavar requested review from carlansley and le-cong October 7, 2025 18:10

jpolavar marked this pull request as draft October 7, 2025 18:32

updated rule to validate all bare-bone helpers

883a9ad

Copilot AI review requested due to automatic review settings October 7, 2025 18:53

jpolavar marked this pull request as ready for review October 7, 2025 18:53

Copilot AI reviewed Oct 7, 2025

View reviewed changes

carlansley requested changes Oct 14, 2025

View reviewed changes

Fixed conflicts

9f506a8

jpolavar requested a review from carlansley October 14, 2025 21:55

le-cong reviewed Oct 15, 2025

View reviewed changes

Added back ignore scripts to publish beta

0fbc420

Copilot AI review requested due to automatic review settings October 15, 2025 17:05

Copilot AI reviewed Oct 15, 2025

View reviewed changes

Removed ignore scripts to publish beta

e245a0f

jpolavar requested a review from le-cong October 15, 2025 17:15

le-cong requested changes Oct 15, 2025

View reviewed changes

Updated to handle document related stuff from lib

f8b9664

jpolavar requested review from Copilot and le-cong October 15, 2025 23:13

Copilot AI reviewed Oct 15, 2025

View reviewed changes

updated publish beta

301232e

le-cong reviewed Oct 16, 2025

View reviewed changes

Extended pattern matching for lib-*

f797e62

jpolavar requested review from Copilot and le-cong October 16, 2025 14:57

Copilot AI reviewed Oct 16, 2025

View reviewed changes

le-cong reviewed Oct 16, 2025

View reviewed changes

Fixed AI comments

c62bc13

jpolavar requested a review from le-cong October 16, 2025 16:08

le-cong approved these changes Oct 16, 2025

View reviewed changes

carlansley approved these changes Oct 24, 2025

View reviewed changes

jpolavar merged commit ab790d1 into main Oct 24, 2025
9 of 10 checks passed

jpolavar deleted the detect-aggregated-aws-commands branch October 24, 2025 20:18

	import getDocumentationUrl from './get-documentation-url.ts';
	import getDocumentationUrl from './get-documentation-url';

	import createTester from './ts-tester.test.ts';
	import createTester from './ts-tester.test';

	'Do not import aggregated AWS SDK v3 client "{{clientName}}". Use bare-bones pattern ({{clientName}}Client + Command) instead.',
	'Do not import aggregated AWS SDK v3 client "{{clientName}}". Use the service-specific *Client class plus Command classes instead.',

		# Enforce Bare-Bones AWS SDK v3 Client Usage

		Ensure that only bare-bones AWS SDK v3 clients and commands are imported and used. Importing and using aggregated clients (e.g., `S3`, `DynamoDB`) is disallowed to promote modularization and enable better tree-shaking for reduced bundle size.

Added new rule 'require-aws-bare-bones' #137

Added new rule 'require-aws-bare-bones' #137

Uh oh!

Conversation

jpolavar commented Oct 7, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

jpolavar commented Oct 7, 2025

Uh oh!

carlansley left a comment

Choose a reason for hiding this comment

Uh oh!

jpolavar commented Oct 14, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jpolavar Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jpolavar Oct 15, 2025 •

edited

Loading