Use formatting convention of trailing comma from input code (#713)

Author: trivikr

.changeset/calm-goats-try.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Use formatting convention of trailing comma from input code

src/transforms/v2-to-v3/__fixtures__/config/credentials.order.input.js

@@ -11,14 +11,14 @@ const credsBefore = new AWS.Config({
   accessKeyId: "KEY",
   secretAccessKey: "SECRET",
   logger: console,
-  region: "us-east-1",
+  region: "us-east-1"
 });
 
 const credsInBetween = new AWS.Config({
   logger: console,
   accessKeyId: "KEY",
   secretAccessKey: "SECRET",
-  region: "us-east-1",
+  region: "us-east-1"
 });
 
 const credsDispersedBefore = new AWS.Config({
@@ -32,5 +32,5 @@ const credsDispersedAfter = new AWS.Config({
   logger: console,
   accessKeyId: "KEY",
   region: "us-east-1",
-  secretAccessKey: "SECRET",
+  secretAccessKey: "SECRET"
 });

src/transforms/v2-to-v3/__fixtures__/config/httpOptions.input.js

@@ -2,6 +2,6 @@ import AWS from "aws-sdk";
 
 const config = new AWS.Config({
   httpOptions: {
-    connectTimeout: 1000,
+    connectTimeout: 1000
   }
 });

src/transforms/v2-to-v3/__fixtures__/config/httpOptions.output.js

@@ -3,6 +3,6 @@ const config = {
   // Refer to UPGRADING.md on aws-sdk-js-v3 for changes needed.
   // Please create/upvote feature request on aws-sdk-js-codemod for httpOptions.
   httpOptions: {
-    connectTimeout: 1000,
+    connectTimeout: 1000
   }
 };

src/transforms/v2-to-v3/__fixtures__/ddb-doc-client/param-convert-empty-values.input.js

@@ -1,5 +1,5 @@
 import AWS from "aws-sdk";
 
 const documentClient = new AWS.DynamoDB.DocumentClient({
-  convertEmptyValues: true,
+  convertEmptyValues: true
 });

src/transforms/v2-to-v3/__fixtures__/ddb-doc-client/param-wrap-numbers.input.js

@@ -1,5 +1,5 @@
 import AWS from "aws-sdk";
 
 const documentClient = new AWS.DynamoDB.DocumentClient({
-  wrapNumbers: true,
+  wrapNumbers: true
 });

src/transforms/v2-to-v3/__fixtures__/misc/trailing-comma.input.js

@@ -0,0 +1,5 @@
+import AWS from "aws-sdk";
+
+const client = new AWS.DynamoDB({
+  region: "us-west-2",
+});

src/transforms/v2-to-v3/__fixtures__/misc/trailing-comma.output.js

@@ -0,0 +1,5 @@
+import { DynamoDB } from "@aws-sdk/client-dynamodb";
+
+const client = new DynamoDB({
+  region: "us-west-2",
+});

src/transforms/v2-to-v3/__fixtures__/s3-upload/global-import-equals.input.ts

@@ -5,5 +5,5 @@ await client.upload({
   Body: "BODY",
   Bucket: "Bucket",
   ContentType: "ContentType",
-  Key: "Key",
+  Key: "Key"
 }).promise();

src/transforms/v2-to-v3/__fixtures__/s3-upload/global-import-equals.output.ts

@@ -11,6 +11,6 @@ await new Upload({
     Body: "BODY",
     Bucket: "Bucket",
     ContentType: "ContentType",
-    Key: "Key",
+    Key: "Key"
   }
 }).done();

src/transforms/v2-to-v3/__fixtures__/s3-upload/global-import.input.js

@@ -5,5 +5,5 @@ await client.upload({
   Body: "BODY",
   Bucket: "Bucket",
   ContentType: "ContentType",
-  Key: "Key",
+  Key: "Key"
 }).promise();

src/transforms/v2-to-v3/__fixtures__/s3-upload/global-import.output.js

@@ -9,6 +9,6 @@ await new Upload({
     Body: "BODY",
     Bucket: "Bucket",
     ContentType: "ContentType",
-    Key: "Key",
+    Key: "Key"
   }
 }).done();

src/transforms/v2-to-v3/__fixtures__/s3-upload/global-require-property.input.js

@@ -5,5 +5,5 @@ await client.upload({
   Body: "BODY",
   Bucket: "Bucket",
   ContentType: "ContentType",
-  Key: "Key",
+  Key: "Key"
 }).promise();

src/transforms/v2-to-v3/__fixtures__/s3-upload/global-require-property.output.js

@@ -14,6 +14,6 @@ await new Upload({
     Body: "BODY",
     Bucket: "Bucket",
     ContentType: "ContentType",
-    Key: "Key",
+    Key: "Key"
   }
 }).done();

src/transforms/v2-to-v3/__fixtures__/s3-upload/global-require.input.js

@@ -5,5 +5,5 @@ await client.upload({
   Body: "BODY",
   Bucket: "Bucket",
   ContentType: "ContentType",
-  Key: "Key",
+  Key: "Key"
 }).promise();

src/transforms/v2-to-v3/__fixtures__/s3-upload/global-require.output.js

@@ -14,6 +14,6 @@ await new Upload({
     Body: "BODY",
     Bucket: "Bucket",
     ContentType: "ContentType",
-    Key: "Key",
+    Key: "Key"
   }
 }).done();

src/transforms/v2-to-v3/__fixtures__/s3-upload/options-identifier.input.js

@@ -6,13 +6,13 @@ const uploadParams = {
   Body: "BODY",
   Bucket: "Bucket",
   ContentType: "ContentType",
-  Key: "Key",
+  Key: "Key"
 };
 const uploadOptions = {
   partSize: 1024 * 1024 * 5,
   queueSize: 1,
   leavePartsOnError: true,
-  tags: [],
+  tags: []
 };
 
 await client.upload(uploadParams, uploadOptions).promise();

src/transforms/v2-to-v3/__fixtures__/s3-upload/options-identifier.output.js

@@ -7,13 +7,13 @@ const uploadParams = {
   Body: "BODY",
   Bucket: "Bucket",
   ContentType: "ContentType",
-  Key: "Key",
+  Key: "Key"
 };
 const uploadOptions = {
   partSize: 1024 * 1024 * 5,
   queueSize: 1,
   leavePartsOnError: true,
-  tags: [],
+  tags: []
 };
 
 await new Upload({

src/transforms/v2-to-v3/__fixtures__/s3-upload/options.input.js

@@ -7,13 +7,13 @@ await client
       Body: "BODY",
       Bucket: "Bucket",
       ContentType: "ContentType",
-      Key: "Key",
+      Key: "Key"
     },
     {
       partSize: 1024 * 1024 * 5,
       queueSize: 1,
       leavePartsOnError: true,
-      tags: [],
+      tags: []
     }
   )
   .promise();

src/transforms/v2-to-v3/__fixtures__/s3-upload/options.output.js

@@ -9,7 +9,7 @@ await new Upload({
     Body: "BODY",
     Bucket: "Bucket",
     ContentType: "ContentType",
-    Key: "Key",
+    Key: "Key"
   },
 
   partSize: 1024 * 1024 * 5,

src/transforms/v2-to-v3/__fixtures__/s3-upload/param-identifier.input.js

@@ -5,7 +5,7 @@ const uploadParams = {
   Body: "BODY",
   Bucket: "Bucket",
   ContentType: "ContentType",
-  Key: "Key",
+  Key: "Key"
 };
 
 await client.upload(uploadParams).promise();

src/transforms/v2-to-v3/__fixtures__/s3-upload/param-identifier.output.js

@@ -6,7 +6,7 @@ const uploadParams = {
   Body: "BODY",
   Bucket: "Bucket",
   ContentType: "ContentType",
-  Key: "Key",
+  Key: "Key"
 };
 
 await new Upload({

src/transforms/v2-to-v3/__fixtures__/s3-upload/service-import-deep.input.js

@@ -5,5 +5,5 @@ await client.upload({
   Body: "BODY",
   Bucket: "Bucket",
   ContentType: "ContentType",
-  Key: "Key",
+  Key: "Key"
 }).promise();

src/transforms/v2-to-v3/__fixtures__/s3-upload/service-import-deep.output.js

@@ -9,6 +9,6 @@ await new Upload({
     Body: "BODY",
     Bucket: "Bucket",
     ContentType: "ContentType",
-    Key: "Key",
+    Key: "Key"
   }
 }).done();

src/transforms/v2-to-v3/__fixtures__/s3-upload/service-import-equals.input.ts

@@ -5,5 +5,5 @@ await client.upload({
   Body: "BODY",
   Bucket: "Bucket",
   ContentType: "ContentType",
-  Key: "Key",
+  Key: "Key"
 }).promise();

src/transforms/v2-to-v3/__fixtures__/s3-upload/service-import-equals.output.ts

@@ -11,6 +11,6 @@ await new Upload({
     Body: "BODY",
     Bucket: "Bucket",
     ContentType: "ContentType",
-    Key: "Key",
+    Key: "Key"
   }
 }).done();

src/transforms/v2-to-v3/__fixtures__/s3-upload/service-import.input.js

@@ -5,5 +5,5 @@ await client.upload({
   Body: "BODY",
   Bucket: "Bucket",
   ContentType: "ContentType",
-  Key: "Key",
+  Key: "Key"
 }).promise();

src/transforms/v2-to-v3/__fixtures__/s3-upload/service-import.output.js

@@ -9,6 +9,6 @@ await new Upload({
     Body: "BODY",
     Bucket: "Bucket",
     ContentType: "ContentType",
-    Key: "Key",
+    Key: "Key"
   }
 }).done();

src/transforms/v2-to-v3/__fixtures__/s3-upload/service-require-deep.input.js

@@ -5,5 +5,5 @@ await client.upload({
   Body: "BODY",
   Bucket: "Bucket",
   ContentType: "ContentType",
-  Key: "Key",
+  Key: "Key"
 }).promise();

src/transforms/v2-to-v3/__fixtures__/s3-upload/service-require-deep.output.js

@@ -14,6 +14,6 @@ await new Upload({
     Body: "BODY",
     Bucket: "Bucket",
     ContentType: "ContentType",
-    Key: "Key",
+    Key: "Key"
   }
 }).done();

src/transforms/v2-to-v3/__fixtures__/s3-upload/service-require.input.js

@@ -5,5 +5,5 @@ await client.upload({
   Body: "BODY",
   Bucket: "Bucket",
   ContentType: "ContentType",
-  Key: "Key",
+  Key: "Key"
 }).promise();

src/transforms/v2-to-v3/__fixtures__/s3-upload/service-require.output.js

@@ -14,6 +14,6 @@ await new Upload({
     Body: "BODY",
     Bucket: "Bucket",
     ContentType: "ContentType",
-    Key: "Key",
+    Key: "Key"
   }
 }).done();

src/transforms/v2-to-v3/transformer.ts

@@ -36,6 +36,7 @@ import {
   getMostUsedIndentationType,
   getMostUsedStringLiteralQuote,
   getValueIndentedWithTabs,
+  isTrailingCommaUsed,
   isTypeScriptFile,
 } from "./utils";
 
@@ -79,6 +80,7 @@ const transformer = async (file: FileInfo, api: API) => {
   // Compute recast options before doing transformations
   const quote = getMostUsedStringLiteralQuote(j, source);
   const useTabs = getMostUsedIndentationType(file.source) === IndentationType.TAB;
+  const trailingComma = isTrailingCommaUsed(j, source);
 
   const awsGlobalConfig = getAwsGlobalConfig(j, source, v2GlobalName);
   for (const [v2ClientName, v3ClientMetadata] of Object.entries(clientMetadataRecord)) {
@@ -113,7 +115,7 @@ const transformer = async (file: FileInfo, api: API) => {
   replaceAwsUtilFunctions(j, source, v2GlobalName);
   removeGlobalModule(j, source, v2GlobalName);
 
-  const sourceString = source.toSource({ quote, useTabs });
+  const sourceString = source.toSource({ quote, useTabs, trailingComma });
 
   if (useTabs) {
     // Refs: https://github.com/benjamn/recast/issues/315

src/transforms/v2-to-v3/utils/index.ts

@@ -3,4 +3,5 @@ export * from "./getClientNewExpression";
 export * from "./getMostUsedStringLiteralQuote";
 export * from "./getMostUsedIndentationType";
 export * from "./getValueIndentedWithTabs";
+export * from "./isTrailingCommaUsed";
 export * from "./isTypeScriptFile";

src/transforms/v2-to-v3/utils/isTrailingCommaUsed.ts

@@ -0,0 +1,12 @@
+import { Collection, JSCodeshift } from "jscodeshift";
+
+export const isTrailingCommaUsed = (j: JSCodeshift, source: Collection<unknown>) => {
+  for (const node of source.find(j.ObjectExpression).nodes()) {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore Property 'extra' does not exist on type 'ObjectExpression'.
+    if (node.extra && node.extra.trailingComma) {
+      return true;
+    }
+  }
+  return false;
+};