html-critical-webpack-plugin

A webpack plugin that will extract critical CSS. Now supports Webpack v4.

  • 所有者: anthonygore/html-critical-webpack-plugin
  • 平台:
  • 許可證: MIT License
  • 分類:
  • 主題:
  • 喜歡:
    0
      比較:

Github星跟蹤圖

HTML Critical Webpack Plugin npm version CircleCI

This plugin extracts critical CSS and runs after all files have been emitted so you can use it after Mini CSS Extract Plugin and HTML Webpack Plugin.

Check out the demo or read the blog post Critical CSS and Webpack: Automatically Minimize Render-Blocking CSS for more details on usage.

Installation

npm i --save-dev html-critical-webpack-plugin

Note: As critical itself has a dependency on puppeteer in order to run Headless Chrome, consumers of this plugin will need to make sure that their build environment (local, CI, etc) where they are running Webpack with this plugin has the necessary operating system packages installed. See this page for more information on troubleshooting puppeteer.

Example

...

const HtmlCriticalWebpackPlugin = require("html-critical-webpack-plugin");

module.exports = {
  mode: 'production',
  plugins: [
    new HtmlWebpackPlugin({ ... }),
    new MiniCssExtractPlugin({ ... }),
    new HtmlCriticalWebpackPlugin({
      base: path.resolve(__dirname, 'dist'),
      src: 'index.html',
      dest: 'index.html',
      inline: true,
      minify: true,
      extract: true,
      width: 375,
      height: 565,
      penthouse: {
        blockJSRequests: false,
      }
    })
  ]
  ...
};

Note: Order is import here since critical, the underlying package used by this plugin, only operates against the file system, and not against webpack's build time compilation. The order of operations by critical is as such:

  1. Reads the file from disk as defined by the src option
  2. Extracts the CSS from that file that is deemed as "critical"
  3. Writes the new file back to disk with that critical CSS inlined, at the location of the dest option

Development

Local environment

Since the main dependency of this project, critical, depends on an environment that supports Headless Chrome, Docker has been provided to support local development of this project.

After you have installed Docker, you can do the following to get setup:

  1. Start the container - docker-compose up -d
  2. SSH into the container - docker exec -it html-critical-webpack-plugin_nodejs_1 /bin/bash
  3. Install dependencies - rm -rf node_modules && npm install (this ensures Linux specific dependencies get installed)

Now you can run the project's npm scripts like usual:

  1. Run unit tests - npm run test
  2. Run the build - npm run ci

Note: changes are bi-directional

Learn more about Docker here or configuring Headless Chrome for your own machine.

Workflows

  1. To run unit tests - npm run test
  2. To build the project - npm run ci
  3. To build the project for release - npm run build

主要指標

概覽
名稱與所有者anthonygore/html-critical-webpack-plugin
主編程語言JavaScript
編程語言JavaScript (語言數: 2)
平台
許可證MIT License
所有者活动
創建於2017-07-19 12:51:46
推送於2020-06-29 21:41:26
最后一次提交2020-06-30 02:11:25
發布數4
最新版本名稱v2.1.0 (發布於 2018-07-08 11:08:48)
第一版名稱1.0.0 (發布於 )
用户参与
星數449
關注者數6
派生數40
提交數97
已啟用問題?
問題數38
打開的問題數18
拉請求數12
打開的拉請求數2
關閉的拉請求數5
项目设置
已啟用Wiki?
已存檔?
是復刻?
已鎖定?
是鏡像?
是私有?