Necromancers Playing MTG

    html-minimizer-webpack-plugin
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.1 • Public • Published

    npm node deps tests cover chat size

    html-minimizer-webpack-plugin

    This plugin uses html-minifier-terser to optimize and minify your HTML.

    Getting Started

    To begin, you'll need to install html-minimizer-webpack-plugin:

    $ npm install html-minimizer-webpack-plugin --save-dev

    Then add the plugin to your webpack configuration. For example:

    webpack.config.js

    const HtmlMinimizerPlugin = require('html-minimizer-webpack-plugin');
    const CopyPlugin = require('copy-webpack-plugin');
    
    module.exports = {
      module: {
        loaders: [
          {
            test: /\.html$/i,
            use: [
              {
                loader: 'file-loader',
                options: {
                  name: '[name].[ext]',
                },
              },
            ],
          },
        ],
      },
      plugins: [
        new CopyPlugin({
          patterns: [
            {
              context: path.resolve(__dirname, 'dist'),
              from: './src/*.html',
            },
          ],
        }),
      ],
      optimization: {
        minimize: true,
        minimizer: [
          // For webpack@5 you can use the `...` syntax to extend existing minimizers (i.e. `terser-webpack-plugin`), uncomment the next line
          // `...`
          new HtmlMinimizerPlugin(),
        ],
      },
    };

    This will enable HTML optimization only in production mode. If you want to run it also in development set the optimization.minimize option to true.

    And run webpack via your preferred method.

    Options

    test

    Type: String|RegExp|Array<String|RegExp> - default: /\.html(\?.*)?$/i

    Test to match files against.

    module.exports = {
      optimization: {
        minimize: true,
        minimizer: [
          new HtmlMinimizerPlugin({
            test: /\.foo\.html/i,
          }),
        ],
      },
    };

    include

    Type: String|RegExp|Array<String|RegExp> Default: undefined

    Files to include.

    webpack.config.js

    module.exports = {
      optimization: {
        minimize: true,
        minimizer: [
          new HtmlMinimizerPlugin({
            include: /\/includes/,
          }),
        ],
      },
    };

    exclude

    Type: String|RegExp|Array<String|RegExp> Default: undefined

    Files to exclude.

    webpack.config.js

    module.exports = {
      optimization: {
        minimize: true,
        minimizer: [
          new HtmlMinimizerPlugin({
            exclude: /\/excludes/,
          }),
        ],
      },
    };

    cache

    Ignored in webpack 5! Please use https://webpack.js.org/configuration/other-options/#cache.

    Type: Boolean|String Default: true

    Enable file caching. Default path to cache directory: node_modules/.cache/html-minimizer-webpack-plugin.

    ℹ️ If you use your own minify function please read the minify section for cache invalidation correctly.

    Boolean

    Enable/disable file caching.

    webpack.config.js

    module.exports = {
      optimization: {
        minimize: true,
        minimizer: [
          new HtmlMinimizerPlugin({
            cache: true,
          }),
        ],
      },
    };

    String

    Enable file caching and set path to cache directory.

    webpack.config.js

    module.exports = {
      optimization: {
        minimize: true,
        minimizer: [
          new HtmlMinimizerPlugin({
            cache: 'path/to/cache',
          }),
        ],
      },
    };

    cacheKeys

    Ignored in webpack 5! Please use https://webpack.js.org/configuration/other-options/#cache.

    Type: Function<(defaultCacheKeys, file) -> Object> Default: defaultCacheKeys => defaultCacheKeys

    Allows you to override default cache keys.

    Default cache keys:

    ({
      htmlMinimizer: require('html-minifier-terser/package.json').version, // html-minifier-terser version
      'html-minimizer-webpack-plugin': require('../package.json').version, // plugin version
      'html-minimizer-webpack-plugin-options': this.options, // plugin options
      nodeVersion: process.version, // Node.js version
      assetName: file, // asset path
      contentHash: crypto.createHash('md4').update(input).digest('hex'), // source file hash
    });

    webpack.config.js

    module.exports = {
      optimization: {
        minimize: true,
        minimizer: [
          new HtmlMinimizerPlugin({
            cache: true,
            cacheKeys: (defaultCacheKeys, file) => {
              defaultCacheKeys.myCacheKey = 'myCacheKeyValue';
    
              return defaultCacheKeys;
            },
          }),
        ],
      },
    };

    parallel

    Type: Boolean|Number Default: true

    Use multi-process parallel running to improve the build speed. Default number of concurrent runs: os.cpus().length - 1.

    ℹ️ Parallelization can speedup your build significantly and is therefore highly recommended.

    Boolean

    Enable/disable multi-process parallel running.

    webpack.config.js

    module.exports = {
      optimization: {
        minimize: true,
        minimizer: [
          new HtmlMinimizerPlugin({
            parallel: true,
          }),
        ],
      },
    };

    Number

    Enable multi-process parallel running and set number of concurrent runs.

    webpack.config.js

    module.exports = {
      optimization: {
        minimize: true,
        minimizer: [
          new HtmlMinimizerPlugin({
            parallel: 4,
          }),
        ],
      },
    };

    minify

    Type: Function Default: undefined

    Allows you to override default minify function. By default plugin uses html-minifier-terser package. Useful for using and testing unpublished versions or forks.

    ⚠️ Always use require inside minify function when parallel option enabled.

    webpack.config.js

    module.exports = {
      optimization: {
        minimize: true,
        minimizer: [
          new HtmlMinimizerPlugin({
            minimizerOptions: {
              collapseWhitespace: true,
            },
            minify: (data, minimizerOptions) => {
              const htmlMinifier = require('html-minifier-terser');
              const [[filename, input]] = Object.entries(data);
    
              return htmlMinifier.minify(input, minimizerOptions);
            },
          }),
        ],
      },
    };

    minimizerOptions

    Type: Object Default: { caseSensitive: true, collapseWhitespace: true, conservativeCollapse: true, keepClosingSlash: true, minifyCSS: true, minifyJS: true, removeComments: true, removeScriptTypeAttributes: true, removeStyleLinkTypeAttributes: true, }

    Html-minifier-terser optimisations options.

    module.exports = {
      optimization: {
        minimize: true,
        minimizer: [
          new HtmlMinimizerPlugin({
            minimizerOptions: {
              collapseWhitespace: false,
            },
          }),
        ],
      },
    };

    Contributing

    Please take a moment to read our contributing guidelines if you haven't yet done so.

    CONTRIBUTING

    License

    MIT

    Install

    npm i html-minimizer-webpack-plugin@1.0.1

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    28.7 kB

    Total Files

    10

    Last publish

    Collaborators

    • evilebottnawi
    • sokra
    • jhnns