Skip to content

Maintenance: set removeComments to false in tsconfig.json #1753

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.

Sign up for GitHub

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

Jump to bottom
Closed
1 of 2 tasks
dreamorosi opened this issue Oct 18, 2023 · 2 comments · Fixed by #1754
Closed
1 of 2 tasks

Maintenance: set removeComments to false in tsconfig.json #1753

dreamorosi opened this issue Oct 18, 2023 · 2 comments · Fixed by #1754
Assignees
@dreamorosi
Labels
completed This item is complete and has been merged/shipped internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)

Comments

@dreamorosi
Copy link
Contributor

Summary

A few weeks ago we changed our tsconfig.json file to adopt TypeScript 5.0 (#1672) and in doing so we inadvertently enabled the removeComments option from the compilerOptions. This caused the docstrings to be stripped from the built output.

We should set the option back to false so that comments are kept.

Why is this needed?

So that customers can get info and examples about methods in their IDEs when using Powertools.

Which area does this relate to?

Automation

Solution

No response

Acknowledgment

Future readers

Please react with 👍 and your use case to help us understand customer demand.
@dreamorosi dreamorosi added internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) confirmed The scope is clear, ready for implementation labels Oct 18, 2023
@dreamorosi dreamorosi self-assigned this Oct 18, 2023
@dreamorosi dreamorosi changed the title Maintenance: TITLE Maintenance: set removeComments to false in tsconfig.json Oct 18, 2023
@dreamorosi dreamorosi mentioned this issue Oct 18, 2023
Merged
9 tasks
@github-actions github-actions bot added pending-release This item has been merged and will be released soon and removed confirmed The scope is clear, ready for implementation labels Oct 18, 2023
@dreamorosi dreamorosi linked a pull request Oct 18, 2023 that will close this issue
chore(maintenance): set removeComments to false in tsconfig.json #1754
Merged
9 tasks
@dreamorosi dreamorosi moved this from Working on it to Shipped in Powertools for AWS Lambda (TypeScript) Oct 18, 2023
@dreamorosi dreamorosi moved this from Shipped to Coming soon in Powertools for AWS Lambda (TypeScript) Oct 18, 2023
@github-actions
Copy link
Contributor

⚠️ 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.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 1, 2023

This is now released under v1.14.1 version!

@github-actions github-actions bot added completed This item is complete and has been merged/shipped and removed pending-release This item has been merged and will be released soon labels Nov 1, 2023
@dreamorosi dreamorosi moved this from Coming soon to Shipped in Powertools for AWS Lambda (TypeScript) Nov 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dreamorosi dreamorosi

Labels
completed This item is complete and has been merged/shipped internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)
Projects
Powertools for AWS Lambda (TypeScript)
Status: Shipped
Milestone
No milestone
1 participant
@dreamorosi