Add badge to display install size

[styfle]

This adds a badge to the README.md file to display the install size of the npm package.

This will catch bugs such as the one described in #23339

[mhegazy]

ppl on the team rarely look at the badges.. so i do not think this is an effective way of measuring output size. I would say a better solution is to do this in jake LKG/gulp LKG which we run manually, we can list the size of the files with a warning message if it is above 10% of the size before the change.

[styfle]

The badge is also useful for users, not just developers of TypeScript

[mhegazy]

I am not sure i agree about the usefulness of the size, specially that it is something we are not optimizing for. for instance we could minify the output, but we are not.. and developers can easily tell how big the package with a quick test.

[styfle]

developers can easily tell how big the package with a quick test

The reason why I wrote Package Phobia is because it's not that quick to test for this, especially for users who are using slow internet connections.

• 3G internet speed is roughly 50 kB per second
• 35935744 bytes / 50000 bytes per second = 718 seconds

That's about 12 minutes to download TypeScript over 3G!

[mhegazy]

Developers can always use hit https://packagephobia.now.sh/result?p=typescript to know how big is the package.. Seems like easy test for me. No need for a badge.

[styfle]

The badge creates some accountability because users will see it...even if they have never heard of Package Phobia.

[mhegazy]

As I noted earlier, this is not something we are willing to commit to, we are not optimizing for package size at the moment.

If you would like to help us keep the package size in check, we would appreciate a change to the jake LKG/gulp LKG commands to check the total size of the lib folder and flag any unexpected increase there.

[styfle]

What is the max size that should cause the build to fail?

[mhegazy]

I would say 10% than the current size.

[styfle]

Ok so I can put a hard limit at 39529266 bytes.

Should I modify run-sequence or add a new check in "LKG"?
https:/Microsoft/TypeScript/blob/master/Gulpfile.js#L585

[mhegazy]

I would say compute the size of the lib folder before the command runs, compare it to that after the command runs, and if the diffrence is more than 10% raise an error.

[styfle]

I saw that the React team uses a dangerfile to add a comment on each PR with the change in size.

It looks like this: facebook/react#12564

This might better than a gulp task because it lets the reviewers decide if it should be merged or not.

Thoughts?

[mhegazy]

Do not think we want to pay the setup cost for a new tool. a check in LKG would be sufficient.

[styfle]

@mhegazy I created PR #24712

Let me know if I did it right or if it needs to be revised, thanks 😅

[mhegazy]

Closing in favor of #24712. thanks @styfle!