[Feature]: Add comment when client constructor input is not an ObjectExpression (like an Identifier)

[trivikr]

Self-service

• I'd be willing to implement this feature

Problem

The config keys are not transformed when client constructor input is not an ObjectExpression (like an Identifier).

Example input:

import AWS from "aws-sdk";

const config = { sslEnabled: true };
const s3 = new AWS.S3(config);

Output:

import { S3 } from "@aws-sdk/client-s3";

const config = { tls: true };
const s3 = new S3(config);

Solution

When an identifier is passed in client constructor, it might have been intialized and updated at several places or called from different file. The transformer does not have access to this data.

However, the transformer can add a comment on any action developer can take, as follows:

import { S3 } from "@aws-sdk/client-s3";

const config = { sslEnabled: true };
// Codemod only supports transformation of config passed as ObjectExpression.
// Please re-run codemod by converting Identifier to ObjectExpression.
const s3 = new S3(config);

Alternatives

Add detection of Identifier creation in the file, and transform it.

Additional context

https://github.com/workadventure/workadventure/blob/596886c66383404a642a333ed8c37e9643b313de/uploader/tests/utils/LocalStackContainer.ts#L13-L14