https://github.com/ritz078/rollup-plugin-filesize

A rollup plugin to show file size of the bundle in the cli
https://github.com/ritz078/rollup-plugin-filesize

cli rollup rollup-plugin theme

Last synced: 3 days ago
JSON representation

A rollup plugin to show file size of the bundle in the cli

• Host: GitHub
• URL: https://github.com/ritz078/rollup-plugin-filesize
• Owner: ritz078
• Created: 2016-01-22T11:49:07.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-02-27T15:43:40.000Z (almost 2 years ago)
• Last Synced: 2024-05-02T00:15:34.813Z (7 months ago)
• Topics: cli, rollup, rollup-plugin, theme
• Language: JavaScript
• Homepage:
• Size: 938 KB
• Stars: 129
• Watchers: 4
• Forks: 26
• Open Issues: 14
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

• awesome - filesize - Display the file size of the bundle in the console. (Plugins / Output)

README

        
# rollup-plugin-filesize

> A rollup plugin to show filesize in the cli

![](screen.png)

## Installation

```

npm install rollup-plugin-filesize

```

## Usage

```js

import { rollup } from 'rollup';

import filesize from 'rollup-plugin-filesize';

rollup({

  entry: 'main.js',

  plugins: [

    filesize()

  ]

}).then(...)

```

## options

#### showMinifiedSize

type: `boolean`

default: true

Whether to show minified size or not

#### showGzippedSize

type: `boolean`

default: true

Whether to show Gzipped size or not

#### showBrotliSize

type: `boolean`

default: false

Whether to show [Brotli](https://www.wikiwand.com/en/Brotli) size or not

#### showBeforeSizes

**Note: this feature is experimental and may be changed in a future release.**

type: `"release"`, `"build"`, or `"none"`

default: `"none"`

Indicates how, if any, comparisons will be shown between the

`output.file` file size as it was and as it is now being written.

If set to `"release"`, will compare the file size at present to that of

the last npm release.

If set to `"build"`, the size of the file that is now being built will

be compared to the immediately previous build. This means that if you run

Rollup multiple times with this option, the info on the previous package

size will be lost (since Rollup will have overwritten your copy), so with

this option, you will need to consult your terminal history to see what the

file size was prior to your changes. This option may be useful if you wish

to compare size changes incrementally as you are developing rather than

comparing to your last release.

#### format

type : `object`

default : {}

See the options [here](https://github.com/avoidwork/filesize.js#optional-settings)

#### reporter

(Note that this replaces the deprecated optional `render` function option.)

type : A reporter string (currently "boxen" only), a function, or an array thereof.

Defaults to "boxen".

After rendering occurs, you may wish to pass on the collected file data,

e.g., to build a badge for filesizes (as does [filesize-badger](https://github.com/brettz9/filesize-badger)).

You can use `reporter` to do so:

```js

filesize({

	reporter: [

		function (options, bundle, {

			minSize, gzipSize, brotliSize, bundleSize,

			fileName,

			// "showBeforeSizes: release"

			lastVersion,

			// "showBeforeSizes: "release" or "showBeforeSizes": "build"

			bundleSizeBefore, brotliSizeBefore, minSizeBefore, gzipSizeBefore

		}) {

			// If a promise is returned, it will be awaited before rendering.

			return promise;

		},

	],

});

```

#### theme

type: `string`

default : 'dark'

options : 'dark'/'light'

choose based on your terminal theme.

## License

MIT