Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TypeScript] Add a step to let user know to install AWS SDK. #730

Open
1 of 2 tasks
monilbid opened this issue Oct 21, 2022 · 3 comments
Open
1 of 2 tasks

[TypeScript] Add a step to let user know to install AWS SDK. #730

monilbid opened this issue Oct 21, 2022 · 3 comments
Labels
effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2

Comments

@monilbid
Copy link

monilbid commented Oct 21, 2022

General Information

  • I may be able to implement this feature request
  • This feature might incur a breaking change

Description

The TypeScript instructions don't explicitly tell the user to install the AWS SDK, so this request is to introduce that instruction.

Proposed Solution

Add a one-liner on how to install the AWS SDK.

CDK CLI Version

No response

Section

No response

Browser

No response

Language

TypeScript

Other information

No response

@monilbid monilbid added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Oct 21, 2022
@peterwoodworth
Copy link
Contributor

Hey @monilbid, thanks for the request.

You don't need to install the sdk because the function won't be ran in your local environment, but rather on AWS Lambda which will have the aws-sdk automatically installed in the environment. Since we're not giving instructions on how to test your Lambda locally (which isn't exclusively something you'd do in CDK) I'd personally prefer we don't add this instruction

Why do you think this should be in the Workshop?

@monilbid
Copy link
Author

Hey Peter!

Thanks for the explanation!

Having it as a dev dependency can help with intellisense. But after your explanation, I think it should be worded differently than the way I did in the PR I created.

@peterwoodworth
Copy link
Contributor

You're right, I agree that it would be nice for intellisense. Perhaps we can install it just with a dev dependency like you say, that could be fine if you note it as optional and say explicitly what it's for :)

@peterwoodworth peterwoodworth added effort/small Small work item – less than a day of effort p2 and removed needs-triage This issue or PR still needs to be triaged. labels Oct 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants