@rmacklin/rollup-plugin-fingerprint

rollup-plugin-fingerprint

Rollup plugin to compose bundle output filenames with unique hashes, to facilitate long-term caching of your static resources.

It uses is simple placeholder pattern to substitue filename with bundle hash. I.e.

main.[hash].js

becomes:

main.07d2bf0d12655d9f51c0637718da4889.js

Install

via npm:

npm install --save-dev rollup-plugin-fingerprint

via yarn:

yarn add --dev rollup-plugin-fingerprint

Usage

import { rollup } from 'rollup';
import fingerprint from 'rollup-plugin-fingerprint';

rollup({
    entry: 'main.js',
    plugins: [
		fingerprint({
			dest: 'main.[hash].js'	
		})
    ]
});

Meanwhile, if dest filename is written the following way, only first 4 characters of hash will be used in final filename: main.[hash:4].js. You could change this number to modify the output result.

Options

dest

Type: string Required: true

The template of your filename destination. Must include the placeholder [hash] to be replaced.

destDir

Type: string Required: false

The directory in which to create the output file. Useful if you don't want the directory to be included in the manifest value.

replace

Type: boolean Default: false Required: false

Whether the hashed version should replace the main output file generated by Rollup. Useful in CI environments where you don't need any non-hashed assets.

algorithm

Type: string Default: sha1 Required: true

Hashing algorithm used to generate hash. Can be one of md5, sha1, sha256, sha512

manifest

Type: string Required: false

Filename to write a manifest to. Will generate a JSON manifest mapping input filename to hashed output filename. Useful if you want to dynamically generate link to your hashed output server-side.

Example manifest:

{
	"main.js": "main.56770a64be1a1132502b276c4132a76bb94d9e1b.js"
}

manifestKey

Type: string Default: bundle.dest Required: false

The filename used as the input key in the generated manifest map. Useful in certain build setups where path.resolve is needed as bundle.dest but not in the manifest.

reuseManifest

Type: boolean Default: false Required: false

Determines whether or not to generate a new manifest for each call to hash(). This option is useful in cases where you want to have multiple bundles created by seperate runs of rollup and have them all be accesible by the same manifest.

This option requires you to delete the manifest yourself when you want to overwrite it

callback

Type: function Required: false

Callback which is called with the resulting hashed filename. This is useful if you are integrating with other build steps and want to store the filename locally to be used in subsequent configs etc.

License

MIT ©