loading...

A new type of Angular budget on the block

jefiozie profile image Jeffrey Bosch Originally published at jefiozie.github.io on ・2 min read

Before we are going to look at the new budget that recently has been added to the Angular CLI, let’s do a small recap on what budgets are.

What are Angular Budgets?

The official documentation says:

As applications grow in functionality, they also grow in size. The CLI allows you to set size thresholds in your configuration to ensure that parts of your application stay within size boundaries that you define.

In other words, bundles are the set of compiled JavaScript files, which are produced by the build process. Angular Budgets allow us to set a threshold around the size of these bundles. With the help of Angular Budgets, we can easily define a condition where we would expect a warning or error threshold if the size of a bundle increases. When an error is provided our build will fail with a bundle error.

The new type of budget on the block:

With the release of Angular CLI version 9.x, a new budget type was introduced. This type is being called the anyComponentStyle

How will this budget help me?

Good question, when we develop an application (or library) our bundle sizes will increase. This is how the development lifecycle is and always will be. However, we like to have them as small as possible and that is where budgets come into play. Where the regular budgets will look at our JavaScript bundles, the anyComponentStyle will look at our individual component CSS files.

Some interesting things to know about the rules that apply with this budget:

  • The budget will throw a warning or an error if any component has styles bigger than the configured threshold, but it will NOT raise any warning or error if the global style is HUGE.
  • The budget will only check individual components
  • At this moment it only supports CSS but there is a PR incoming to support other extensions as well.

How is the new budget type defined

Previously, the angular.json contained a default budget rule like:

"budgets": [
 {
   "type": "initial",
   "maximumWarning": "2mb",
   "maximumError": "5mb"
 }
]

When migrating to the new version of the Angular CLI, you will find a new budget added to the angular.json, which looks like:

"budgets": [
 {
   "type": "initial",
   "maximumWarning": "2mb",
   "maximumError": "5mb"
 },
 {
   "type": "anyComponentStyle",
   "maximumWarning": "6kb",
   "maximumError": "10kb"
 }
]

This new definition is where you can set the constraints for a warning or error message when a component’s CSS file is exceeding this size.

Thank you!

I hope you enjoyed this article! I would appreciate if you would share this article to spread the word around this new cool budget!Also big thanks for some great reviewers:

Please, don’t hesitate to ping me if you have any questions around Angular via Twitter @jefiozie.

RESOURCES

Posted on by:

jefiozie profile

Jeffrey Bosch

@jefiozie

My name is Jeffrey and I’m a frontend develop working on all kinds of stuff. - Member of @xlayers - Author of ngx-aws-deploy

Discussion

markdown guide