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

build: do not remove comments #3813

Merged
merged 1 commit into from Sep 15, 2022
Merged

build: do not remove comments #3813

merged 1 commit into from Sep 15, 2022

Conversation

mrazauskas
Copy link
Contributor

Summary

Currently the library is build with "removeComments": true set and most probably there is a reason for that.

Just wanted to draw your attention that that together with other comments @deprecated tags are getting removed as well. The JSDoc comments are also missing in the build file. Aren’t these supposed to reach the users?

Test plan

Checked output files in the dist directory locally.

Does this PR introduce a breaking change?

  • Yes
  • No

@ahnpnl
Copy link
Collaborator

ahnpnl commented Sep 14, 2022

We need to set removeComment: true because we want to mark some stuffs as @internal which tsc won't generate types for those.

@mrazauskas
Copy link
Contributor Author

mrazauskas commented Sep 14, 2022

And "stripInternal": true (which is also set) is not enough in this case? Looking at the build files quickly, seems like it does the job. Do I miss something?

@coveralls
Copy link

coveralls commented Sep 14, 2022

Pull Request Test Coverage Report for Build 3053528879

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.5%) to 96.355%

Totals Coverage Status
Change from base Build 3047567255: 0.5%
Covered Lines: 3996
Relevant Lines: 4093

💛 - Coveralls

Copy link
Collaborator

@ahnpnl ahnpnl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh ya it works, I remember it didn't in the past, thanks!

@ahnpnl ahnpnl merged commit 8011d5d into kulshekhar:main Sep 15, 2022
@mrazauskas mrazauskas deleted the chore-do-not-remove-comments branch September 15, 2022 07:03
@mrazauskas
Copy link
Contributor Author

Thanks for considering! I though @deprecated will be helpful for the users to migrate their Jest configs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants