https://github.com/polyneue/gulp-asset-cache

A disc based caching task for gulp.
https://github.com/polyneue/gulp-asset-cache

asset-cache cache gulp gulp-plugin

Last synced: about 1 month ago
JSON representation

A disc based caching task for gulp.

• Host: GitHub
• URL: https://github.com/polyneue/gulp-asset-cache
• Owner: Polyneue
• License: mit
• Created: 2016-07-19T13:00:02.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-05-12T12:11:56.000Z (over 7 years ago)
• Last Synced: 2024-11-21T19:09:40.196Z (about 2 months ago)
• Topics: asset-cache, cache, gulp, gulp-plugin
• Language: JavaScript
• Homepage:
• Size: 29.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gulp-asset-cache

[![Build Status](https://travis-ci.org/Polyneue/gulp-asset-cache.svg?branch=master)](https://travis-ci.org/Polyneue/gulp-asset-cache)

[![Coverage Status](https://coveralls.io/repos/github/Polyneue/gulp-asset-cache/badge.svg?branch=master)](https://coveralls.io/github/Polyneue/gulp-asset-cache?branch=master)

[![bitHound Dependencies](https://www.bithound.io/github/Polyneue/gulp-asset-cache/badges/dependencies.svg)](https://www.bithound.io/github/Polyneue/gulp-asset-cache/master/dependencies/npm)  

A disk based caching task for [gulp](http://gulpjs.com/). This plugin was built mainly to deal with the issues around having no dist directory and wanting to prevent image/video compression from happening multiple times on larger teams. If you do have the luxury of a src/dist file structure I recommend [gulp-changed](https://www.npmjs.com/package/gulp-changed) or [gulp-newer](https://www.npmjs.com/package/gulp-newer) as they easily integrate with that setup.  

## Installation

Install package with NPM and add it to your development dependencies:  

```

npm install gulp-asset-cache

```

## Example

Below is a basic example of using the cache to manage image minification with the imagemin module.  

```javascript

const gulp = require('gulp');

const imagemin = require('gulp-imagemin');

const assetCache = require('gulp-asset-cache');

gulp.task('images', function() {

  return gulp.src('./images/*.{jpg,png,jpeg,gif,svg}')

    // Specify the location and name of the cache file

    .pipe(assetCache.filter('./images/.image-cache'))

    .pipe(imagemin({

      verbose: true

    }))

    .pipe(gulp.dest('./images/'))

    .pipe(assetCache.cache());

});

```

This will create a cache file named `.image-cache` of all files passed through the pipeline to be excluded from subsequent runs. If a file that has been cached is updated, the cache will recognize this and pass the file through to update it in the cache.  

## API  

### assetCache.filter(cacheName)  

Generate a file that will contain all of the information related to the cache. If a file already exists, it will filter out the items within the cache from the stream.

**Parameters:**  

| Name | Type | Default Value | Description |

| --- | --- | --- | --- |

| cacheName | string | './.asset-cache' | The name and location of where the cache file will be saved. |

### assetCache.cache()  

Create or update the currently streamed cache file.  

## License

MIT