Automating the critical CSS inlining with npm scripts

Mar 09, 2016

A few months ago I published an article about inlining critical CSS to improve content-first-pages performance and looking at the stats it became quite popular. Later I wrote another one about the benefits of using npm scripts when possible, so consider this a merge of both.

I will avoid an introduction about these topics, but you can go to my previous posts about critical css inlining and npm scripts and then come back.

Divide and conquer

Nowadays it's really weird to not use a preprocessor, so let's suppose we are using LESS. The file structure might change depending on your needs and you can use imports to improve the maintainability of your project, for now we're going to create two files containing the critical and noncritical styles.

├── src
│	└── styles
│      	├── critical.less
│      	└── noncritical.less

Keeping it simple

First thing is to detect what we need to do, in order to know what packages we're going to install. For this recipe, process .less files, minimize them and move them to the correct folder.

To visualize how powerful npm scripts are, this is all we need to install.

npm install --save-dev less cssmin

Noncritical

In the scripts property of the package.json file of your project, add a styles:noncritical task.

{
  ...
  "scripts": {
	"styles:noncritical": "lessc src/styles/noncritical.less | cssmin > assets/styles/site.css"
  }
}

Just like in the solution I proposed with Gulp, the result goes to an assets/styles/ folder, but npm scripts will not try to create it and throw an error in your terminal.

You can create it manually or install the mkdirp package and write a simple prescript.

npm install --save-dev mkdirp

{
  ...
  "scripts": {
	"prestyles:noncritical": "mkdirp assets/styles",
	"styles:noncritical": "lessc src/styles/noncritical.less | cssmin > assets/styles/site.css"
  }
}

Critical

For this one the solution is pretty much the same, the only differences are the destination folder and the extension of the file. Both will depend on the engine you're using to generate your site, this example should work for Jekyll sites.

{
  ...
  "scripts": {
	...
	"prestyles:critical": "mkdirp _includes",
	"styles:critical": "lessc src/styles/critical.less | cssmin > _includes/criticalCSS.html"
  }
}

We are exporting the result as an .html file because that's the type of file Jekyll uses for includes, the next thing is to add it in the head of your site between style tags.

<head>
  ...
  <style>
    {% include criticalCSS.html %}
  </style>
</head>

Adapt the solution to other platforms

In Wordpress the solution doesn't differ that much. This time the file will be exported with a .php extension and use the correct include pattern.

{
  ...
  "scripts": {
	...
	"styles:critical": "lessc src/styles/critical.less | cssmin > wp-content/themes/your_theme/criticalCSS.php"
  }
}

Take in count that the path could change depending on where your package.json is placed and the name of the Wordpress theme.

<head>
  ...
  <?php include (TEMPLATEPATH . '/criticalCSS.php'); ?>
</head>

Grouping tasks

To simplify the execution of them we can put these both tasks together in a new one.

{
  ...
  "scripts": {
	"prestyles:noncritical": "mkdirp assets/styles",
	"styles:noncritical": "lessc src/styles/noncritical.less | cssmin > assets/styles/site.css",
	"prestyles:critical": "mkdirp _includes",
	"styles:critical": "lessc src/styles/critical.less | cssmin > _includes/criticalCSS.html",
	"styles": "npm run styles:noncritical & npm run styles:critical"
  }
}

Now, you can just run npm run styles and presto!

Watch 'em all

To really automate this task let's install a new package that will watch any change on our .less files and run the necessary task for us.

npm install --save-dev onchange

Add a watch script.

{
  ...
  "scripts": {
	"prestyles:noncritical": "mkdirp assets/styles",
	"styles:noncritical": "lessc src/styles/noncritical.less | cssmin > assets/styles/site.css",
	"prestyles:critical": "mkdirp _includes",
	"styles:critical": "lessc src/styles/critical.less | cssmin > _includes/criticalCSS.html",
	"styles": "npm run styles:noncritical & npm run styles:critical",
	"watch:styles": "onchange src/**/*.less -- 'npm run styles'"
  }
}

Finally we can write npm run watch:styles in the terminal and the styles script will run every time we modify any style in our project.

Wrap-up

This is a base solution for CSS inlining using npm scripts and it might differ depending on how your site is built and what you're using to write its styles, but it shouldn't be hard to adapt.

Do you want me to write for your publication? Click here to contact me via email.

# Divide and conquer

# Keeping it simple

# Noncritical

# Critical

# Adapt the solution to other platforms

# Grouping tasks

# Watch 'em all

# Wrap-up