Coder Social home page Coder Social logo

esbuild-plugin-html-minifier-terser's Introduction

esbuild-plugin-html-minifier-terser

esbuild plugin to minify html files

Features

  • Using HTMLMinifier
  • Minify HTML files output by other plugins such as @craftamap/esbuild-plugin-html and esbuild-plugin-copy.

Installation

npm i -D html-minifier-terser
npm i -D esbuild-plugin-html-minifier-terser

Options

include

Type: string | string[]

Default: '**/*.html'

Glob patterns of files to be minified.

baseDir

Type: 'outdir' | 'workingDir'

Default: 'outdir'

Base directory for include option.

minifierOptions

Type: import('html-minifier-terser').Options

Default:

{
  caseSensitive: true,
  collapseWhitespace: true,
  keepClosingSlash: true,
  minifyCSS: true,
  minifyJS: true,
  removeComments: true,
}

HTMLMinifier options. Not merged with the default minifierOptions object.

Examples

Use With @craftamap/esbuild-plugin-html

By default, include is '**/*.html' and baseDir is 'outdir', so all files with .html extension output in the dist directory will be minified.

// build.js
import esbuild from 'esbuild';
import { htmlPlugin } from '@craftamap/esbuild-plugin-html';
import htmlMinifierPlugin from 'esbuild-plugin-html-minifier-terser';

esbuild.build({
  entryPoints: ['src/main.js'],
  outdir: 'dist',
  metafile: true,
  plugins: [
    htmlPlugin({
      files: [
        {
          entryPoints: ['src/main.js'],
          filename: 'index.html',
        },
      ],
    }),
    htmlMinifierPlugin(),
  ],
});
./
  src/
    main.js
  dist/
    main.js
    index.html (will be minified)
  build.js

Minify Specific Files

To minify only specific files, set the glob pattern to include. If you need to minify files that are not in outdir, set baseDir to 'workingDir'.

// build.js
import esbuild from 'esbuild';
import htmlMinifierPlugin from 'esbuild-plugin-html-minifier-terser';

esbuild.build({
  plugins: [
    htmlMinifierPlugin({
      include: 'public/main.html',
      baseDir: 'workingDir',
    }),
  ],
});
./
  public/
    main.html (will be minified)
    sub.html
  build.js

Use Custom Options for HTMLMinifier

Customized minifierOptions will NOT be merged with the default object.

import esbuild from 'esbuild';
import htmlMinifierPlugin from 'esbuild-plugin-html-minifier-terser';

esbuild.build({
  ...
  plugins: [
    htmlMinifierPlugin({
      minifierOptions: {
        collapseWhitespace: true,
        useShortDoctype: true,
      },
    }),
  ],
});

esbuild-plugin-html-minifier-terser's People

Contributors

level222 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.