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

Docs: Cookiecutter project template with TypeScript Powertools setup (with SAM) #391

Closed
ijemmy opened this issue Jan 3, 2022 · 9 comments
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation

Comments

@ijemmy
Copy link
Contributor

ijemmy commented Jan 3, 2022

Description of the feature request

Problem statement
Setting up in TypeScript development environment is difficult and require a lot of manual steps. For users who want to test PowerTool without integrating it into an existing TypeScript project, it could take a very long time (hours, or even days to get config right).

Summary of the feature
We provide a Cookiecutter template with TypeScript PowerTool already setup. It has API + 3 functions that uses all 3 core features

Each function will use the following options:

  1. Manually
  2. Middy Middleware
  3. Decorator

Code examples
sam init --location gh:aws-samples/cookiecutter-aws-sam-typescript-with-powertools

Ref documentation

Benefits for you and the wider AWS community

  1. Ease of learning for new users. They can test it in actual live environment (required for feature like Tracer) instead of just looking at the code.
  2. Ease of starting a new project. This increases adoption speed.

Describe alternatives you've considered
N/A

Additional context
N/A

Related issues, RFCs

N/A

@ijemmy ijemmy added the triage This item has not been triaged by a maintainer, please wait label Jan 3, 2022
@dreamorosi dreamorosi added this to the production-ready-release milestone Jan 3, 2022
@dreamorosi
Copy link
Contributor

Here some references of cookiecutter-based project from Python & Java.

If using SAM cookiecutter is nice, as alternative I'd like to also pitch creating a projen template (they accept PRs to add templates) for those who don't use SAM & just want a nice TS setup.

@michaelbrewer
Copy link
Contributor

@dreamorosi sam now supports Typescript. So it might be a good time to add this :)

@dreamorosi
Copy link
Contributor

@dreamorosi sam now supports Typescript. So it might be a good time to add this :)

See aws/aws-sam-cli-app-templates#193

To manage expectations: this is still in a preliminary phase as TS was just added to SAM and there's a few things we want to settle on our side before merging that PR, but we're on it.

@dreamorosi dreamorosi added documentation Improvements or additions to documentation enhancement and removed triage This item has not been triaged by a maintainer, please wait labels Feb 28, 2022
@VRMink
Copy link

VRMink commented Mar 31, 2022

@michaelbrewer, do you have a link describing typescript support in SAM?
As this issue suggest, I have just spent 2 days trying to get SAM to play nice with TypeScript, I came here to see how you guys had managed to do it, and to adopt your Powertool.

Looking forward to seeing this solution come alive, till then I will be using JS

@michaelbrewer
Copy link
Contributor

@dreamorosi
Copy link
Contributor

Hello @VRMink we are also working on adding SAM examples to this repo, you can track progress under this PR.

@dreamorosi
Copy link
Contributor

Hi @VRMink, we have added an example that uses SAM & TypeScript to this repo, you can find it under examples/sam.

A cookiecutter template for SAM it's also on its way aws/aws-sam-cli-app-templates#193.

@dreamorosi dreamorosi changed the title feat(all): Cookiecutter project template with TypeScript Powertool setup (with SAM) Feature (all): Cookiecutter project template with TypeScript Powertools setup (with SAM) May 12, 2022
@saragerion saragerion removed this from the production-ready-release milestone May 16, 2022
@dreamorosi
Copy link
Contributor

The PR linked above was merged 10 days ago and the cookie cutter template is now available in SAM CLI (see screenshot below):

image

@github-actions
Copy link
Contributor

github-actions bot commented Jul 7, 2022

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@dreamorosi dreamorosi added the completed This item is complete and has been merged/shipped label Nov 14, 2022
@dreamorosi dreamorosi changed the title Feature (all): Cookiecutter project template with TypeScript Powertools setup (with SAM) Docs: Cookiecutter project template with TypeScript Powertools setup (with SAM) Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

5 participants