aws / aws-sdk-js-v3

Modularized AWS SDK for JavaScript.
Apache License 2.0
2.96k stars 556 forks source link

docs: use `pnpm add <pkg>` instead of `pnpm install <pkg>` #6066

Closed jferrettiboke closed 1 month ago

jferrettiboke commented 2 months ago

Describe the issue

It should be pnpm add @aws-sdk/client-s3 instead of pnpm install @aws-sdk/client-s3.

pnpm install is used to install all dependencies for a project while pnpm add <pkg> is used to install a package and any packages that it depends on.

More info (official source):

Screenshot 2024-05-05 at 20 01 36

Links

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/

aBurmeseDev commented 1 month ago

Hi @jferrettiboke - thanks for sharing this.

I attempted to run pnpm install @aws-sdk/client-s3 and pnpm add @aws-sdk/client-s3 in different projects and upon checking the dependencies, they both have same dependencies installed. Are you seeing different? I'll double check with the team to further verify.

Best, John

jferrettiboke commented 1 month ago

@aBurmeseDev pnpm install <pkg> does the same as pnpm add <pkg> today, but it might stop functioning that way in future versions since the official docs clarify the difference between the two. It might be that pnpm install <pkg> was used in past versions, and the PNPM team didn't want to remove support for it right away after introducing pnpm add <pkg>.

trivikr commented 1 month ago

Internal fix is in CR-126891228 for API Reference. This issue will be updated once the fix is merged, with expected time of doc deployment.

trivikr commented 1 month ago

Internal fix is in CR-126891228 for API Reference. Internal fix is merged.

The change is expected to go live around 6:30 PM Pacific on Tue May 14th.

aBurmeseDev commented 1 month ago

@jferrettiboke - this has been updated on our documentation for all clients now. Thanks again for reporting. Closing now.

github-actions[bot] commented 1 month ago

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.