You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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
The text was updated successfully, but these errors were encountered: