gulp-hash-changed

Yet another only pass through changed files gulp plugin.

A very simple gulp plugin to skip files already processed.

This implementation generated from a very specific case. On the first run, it creates a JSON mapping the source file name to its content (hash). The JSON is permanently stored (unless you manually delete it) so to be used on the following runs (even months or years later) to check if the source file has(h) [pun here!] changed (note: if the processed files changes name or location, it will considered as changed).

How is this different from gulp-changed or other similar plugins? gulp-changed checks against build files, gulp-hash-changed checks the content of the source file, keep a permanent record of its hash and its very suitable for production build and all other useful cases I did not think about where other plugins don't five the expected result.

Plus, it was so fun to build 🎉

If you plan to use it within a watch task, I would recommend to check other plugins here.

Installation

npm i -D gulp-hash-changed

Usage (standalone)

A standalone implementation is to come very soon. Keep watching the plugin.

Usage (with gulp-if)

This plugin is currently intended to be used in combination with gulp-if.

const gulpif = require('gulp-');
const hashChanged = require('gulp-hash-changed');
  
gulp.src('your/source/dir/*.png')
        .pipe(
            gulpif(
                hashChanged(),
                imagemin()
            )
         )
        .pipe(gulp.dest('your/dest/dir')));

API

hashChanged(options)

currentDir

* `string`
* default = process.cwd()

The dir relative to which the hashesfile will be created.

currehashalgntDir

* `string`
* default = md5

hashesfile

* `string`
* default = fileshashes.json

The file which will contain { 'path/to/source/file/name': 'hash' }.

force

* `boolean`
* default = '--force' === process.argv[3]

Use it to basically skip what the plugin is doing (useful in many cases). You can set it to true in the gulp file (maybe temporarily or based on some conditions) or by adding just --force.

stopOnError

* `boolean`
* default = true

Should the plugin throw an error if something wrong? If you just want to be notified of the error without stopping the file processing, use false (that's what I use: I don't want to block the build at my company 😅)

Tests

npm test

Contributing

👉 Please, contribute! Or open issues, if you have questions or suggestions!

Just take care to maintain the existing coding style. Add unit tests whenever functionality are added or changed.

Supporting

I believe in Unicorns 🦄 Support me, if you do too.

Release History

• 0.0.1 Initial release

License

MIT