Skip to content

Commit d31a5d4

Browse files
authored
docs: recommend latest version of codemod in README (#569)
1 parent 8fb8221 commit d31a5d4

File tree

3 files changed

+9
-11
lines changed

3 files changed

+9
-11
lines changed

.changeset/shiny-drinks-deny.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"aws-sdk-js-codemod": patch
3+
---
4+
5+
Recommend using latest version of aws-sdk-js-codemod

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,11 @@ To use aws-sdk-js-codemod, please install [Node.js][install-nodejs].
2121

2222
- Optionally execute dry-run for the transform, and print transformed files on stdout:
2323
```console
24-
npx aws-sdk-js-codemod --dry --print -t v2-to-v3 PATH...
24+
npx aws-sdk-js-codemod@latest --dry --print -t v2-to-v3 PATH...
2525
```
2626
- Run transform, and make changes to files:
2727
```console
28-
npx aws-sdk-js-codemod -t v2-to-v3 PATH...
29-
```
30-
- To use the latest version of aws-sdk-js-codemod, clear your npx cache. You can either
31-
manually delete folder `$(npm get cache)/_npx/*`, or run `clear-npx-cache`.
32-
```console
33-
npx clear-npx-cache
28+
npx aws-sdk-js-codemod@latest -t v2-to-v3 PATH...
3429
```
3530

3631
## Example
@@ -46,7 +41,7 @@ client.listTables({}, (err, data) => {
4641
else console.log(data);
4742
});
4843

49-
$ npx aws-sdk-js-codemod -t v2-to-v3 example.ts
44+
$ npx aws-sdk-js-codemod@latest -t v2-to-v3 example.ts
5045

5146
$ cat example.ts
5247
import { DynamoDB } from "@aws-sdk/client-dynamodb";

src/utils/getHelpParagraph.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ You can provide names of the custom transforms instead of a local path or url:
1212
1313
${transforms.map((transform) => getTransformDescription(transform).join("\n"))}
1414
15-
Example: aws-sdk-js-codemod -t v2-to-v3 example.js
16-
17-
To use the latest version of aws-sdk-js-codemod, please clear your npx cache and re-run.
15+
Example: npx aws-sdk-js-codemod@latest -t v2-to-v3 example.js
1816
1917
${separator}\n\n`;

0 commit comments

Comments
 (0)