Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

rollup-plugin-esbuild-minify

prantlf69.1kMIT1.2.0

Rollup plugin to minify or clean up generated bundles using esbuild.

rollup, plugin, rollup-plugin, minify, esbuild

readme

rollup-plugin-esbuild-minify

Latest version Dependency status Coverage

Rollup plugin to minify or clean up generated bundles using esbuild.

Simpler than rollup-plugin-esbuild and rollup-plugin-esbuild-transform, focusing only on minification of the bundled JavaScript output. Faster than @rollup/plugin-terser. See also benchmark results of various minifiers.

Synopsis

import { minify } from 'rollup-plugin-esbuild-minify'

export default {
  plugins: [minify()]
  // the rest of the configuration
}

Installation

Make sure that you use Node.js 14 or newer and Rollup 2 or newer. Use your favourite package manager - NPM, PNPM or Yarn:

npm i -D rollup-plugin-esbuild-minify
pnpm i -D rollup-plugin-esbuild-minify
yarn add -D rollup-plugin-esbuild-minify

Usage

Create a rollup.config.js configuration file and import the plugin:

import { minify } from 'rollup-plugin-esbuild-minify'

export default {
  input: 'src/index.js',
  output: { file: 'dist/main.js', format: 'iife', sourcemap: true },
  plugins: [
    minify({ logLevel: 'debug', logLimit: 100 })
  ]
}

Then call rollup either via the command-line or programmatically.

Options

The following options can be passed in an object to the plugin function to change the default values.

logLevel

Type: 'silent' | 'error' | 'warning' | 'info' | 'debug' | 'verbose'
Default: 'warning'

Controls the number and detail of progress messages logged on the console.

See also the original documentation.

logLimit

Type: Integer
Default: 10

Maximum number of logged messages. If zero (0) is provided, all messages will be logged.

See also the original documentation.

legalComments

Type: 'none' | 'inline' | 'eof' | 'linked' | 'external'
Default: 'none'

Allows including or extracting legal comments. A "legal comment" is considered to be any statement-level comment that contains @license or @preserve or that starts with //! or /*!.

See also the original documentation.

minify

Type: Boolean
Default: true

Allows disabling the minification. The code will be pretty-printed instead. It can be used to clean up the code.

See also the original documentation.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Lint and test your code.

License

Copyright (C) 2022-2024 Ferdinand Prantl

Licensed under the MIT License.

changelog

Changes

1.2.0 (2024-12-10)

Features

1.1.2 (2024-08-06)

Bug Fixes

Also add the exports property to package.json.

1.1.1 (2023-10-08)

Bug Fixes

  • Upgrade dependencies, support Rollup 4 (7a929b6)

1.1.0 (2023-04-23)

Features

  • Allows disabling the minification to just clean up the code (131c10e)
  • Allows including or extracting legal comments (911ee5b)
  • Reduce the default log level to warning (d721de8)

1.0.8 (2023-04-23)

Bug Fixes

1.0.7 (2022-10-30)

Bug Fixes

  • Upgrade dependencies, support Rollup 3 (1e43db9)

1.0.6 (2022-08-01)

Bug Fixes

1.0.5 (2022-06-18)

Bug Fixes

  • Omit format from esbuild as long as possible (9c53f58)
  • Upgrade dependencies (bf558aa)

1.0.4 (2022-06-03)

Bug Fixes

1.0.3 (2022-06-03)

Bug Fixes

  • Fix column position of an error (ebb3fcf)

1.0.2 (2022-05-19)

Bug Fixes

  • Remove lit from peer deps (9c5cc85)

1.0.1 (2022-05-18)

Bug Fixes

  • Remove all comments when minifying (0051cb2)

1.0.0 (2022-05-18)

Initial release