A fork of metalsmith-fingerprint that discards the original file
This plugin fingerprints your files for easy and reliable cache-busting. Since you're not going to use the original, this fork discards it by default (but still allows you to keep it if you want to).
npm install metalsmith-fingerprint-ignore
Say you want to fingerprint the file css/index.css
:
Metalsmith(__dirname)
.use(fingerprint({ pattern: 'css/index.css' }))
.use(template({ engine: 'handlebars' }))
.build()
The plugin does three things:
- create a duplicate of
index.css
with a fingerprinted filename - create a
fingerprint
object on the Metalsmith metadata - Discard the original
index.css
file
The fingerprint
object is accessible from the Handlebars template:
<link href="{{ fingerprint.[css/index.css] }}" rel="stylesheet" type="text/css" />
And the template renders the fingerprinted filename:
<link href="css/index-724af9dd72a48c18dd570790c2445fb4.css" rel="stylesheet" type="text/css" />
You can pass options to metalsmith-fingerprint-ignore
with the Javascript API or CLI. The options are:
- pattern: a pattern to filter source files (required)
- keep: keep source file, false by default (optional)
String|Array<String>
: A pattern to filter source files. The path is relative to your source
. Required.
{
"plugins": {
"metalsmith-fingerprint-ignore": {
"pattern": "css/index.css"
}
}
}
Boolean
: Keep the original file. Setting it to true will keep the original file and create a fingerprinted version as well. Default false
. Optional.
{
"plugins": {
"metalsmith-fingerprint-ignore": {
"pattern": "css/index.css",
"keep": "true"
}
}
}
Metalsmith fingerprint does not discard the original file after fingerprinting. So when fingerprinting a large collection of files you'll have to manually ignore them all. Unfortunately the only predictable difference between the original and the fingerprinted file is the dash before the fingerprint.
An issue was opened to address this, but closed as wontfix
. So this fork is based on the PR by callum, which can be used by those who would still like this functionality.
Thanks to:
MIT.