[Bug]: The v2-to-v3 transform removes top level comment

[trivikr]

Self-service

• I'd be willing to implement a fix

Describe the bug

The v2-to-v3 transform removes top level comment

Template name

v2-to-v3

Input code

// Top level comment
import AWS from "aws-sdk";

// Create client
const client = new AWS.DynamoDB({ region: "us-west-2" });

// Make listTables call
client.listTables({}, (err, data) => {
  if (err) console.log(err, err.stack);
  else console.log(data);
});

Observed failure

No failure, but the top level comment is removed

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

// Create client
const client = new DynamoDB({ region: "us-west-2" });

// Make listTables call
client.listTables({}, (err, data) => {
  if (err) console.log(err, err.stack);
  else console.log(data);
});

Expected output

// Top level comment
import { DynamoDB } from "@aws-sdk/client-dynamodb";

// Create client
const client = new DynamoDB({ region: "us-west-2" });

// Make listTables call
client.listTables({}, (err, data) => {
  if (err) console.log(err, err.stack);
  else console.log(data);
});

### Environment

```shell
aws-sdk-js-codemod: 0.6.4

jscodeshift: 0.14.0
 - babel: 7.20.5
 - babylon: 7.20.5
 - flow: 0.196.2
 - recast: 0.21.5

Additional context

No response

[trivikr]

This happens in both import and require.
https://github.com/awslabs/aws-sdk-js-codemod/blob/main/src/transforms/v2-to-v3/utils/remove/removeDefaultModuleIfNotUsed.ts

It happens has recast considers comment as part of VariableDeclaration (in case of require), as shown in the screenshot below.

Screenshot

[trivikr]

Comment is considered as part of variable declaration, even if it's a block comment and has newline

Screenshot

[trivikr]

Attempts to fix can be viewed in #206

Closing as wontfix, as this issue is minor as compared to other bug reports or feature requests. Also, there's no straightforward way to preserve comments.

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.