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

Review if it is necessary to keep JSDoc comments in built files #5504

Open
2 tasks
romaricpascal opened this issue Nov 15, 2024 · 0 comments
Open
2 tasks

Review if it is necessary to keep JSDoc comments in built files #5504

romaricpascal opened this issue Nov 15, 2024 · 0 comments

Comments

@romaricpascal
Copy link
Member

What

Review what benefits users gain from preserving some of the JSDoc comments in the built output and if we need to take any action to amend our configuration

Why

We use Babel to remove some of the comments in the built code, but preserve specific comments. It's unclear which tools benefit from these extra comments, which have quite an impact on the file size (even though they'll be removed by the project's minifiers anyway... provided they have a minifier). Especially with TypeScript possibly only looking at these comments if you explicitely include the files from 'govuk-frontend' in its configuration, these extra comments may well be only adding some bloat.

Thanks @colinrotherham for bringing that to our attention.

Who needs to work on this

Developers

Who needs to review this

Developers

Done when

  • We've understood which situation the extra JSDoc comments bring benefits
  • We've created issues for actions we need to take, if any
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant