# gulp-zabcache

> Generate HTML5 Cache Manifest

Latest version **0.0.6** (published 2016-05-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-zabcache
pnpm add gulp-zabcache
yarn add gulp-zabcache
bun add gulp-zabcache
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2016-05-05 |
| First published | 2016-05-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | marcozabo |
| Maintainers | marcozabo |
| Keywords | gulp, gulpplugin, html5, manifest, appcache |

## Links

- npm: https://www.npmjs.com/package/gulp-zabcache
- Repository: https://github.com/marcozabo/gulp-zabcache
- Homepage: https://github.com/marcozabo/gulp-zabcache#readme
- Issues: https://github.com/marcozabo/gulp-zabcache/issues
- npm.io page: https://npm.io/package/gulp-zabcache

## Dependencies (6)

- [slash](https://npm.io/package/slash.md) ^0.1.1
- [through](https://npm.io/package/through.md) ~2.3.4
- [gulp-util](https://npm.io/package/gulp-util.md) ~2.2.6
- [event-stream](https://npm.io/package/event-stream.md) ~3.0.20
- [gulp-replace](https://npm.io/package/gulp-replace.md) ^0.5.4
- [app-root-path](https://npm.io/package/app-root-path.md) ^1.0.0

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 0.0.6 (latest) — 2016-05-05

## README

# gulp-zabcache 
> Forked from: https://github.com/Sharique-Hasan/gulp-appcache

## Editing

Many thanks to Sharique-Hasan who developed [gulp-appcache](https://github.com/Sharique-Hasan/gulp-appcache) for gulpjs. I made few changes in the plugin to put project version in manifest, handle explicit file list and add manifest attribute in html tag
 

## Usage

```shell
npm install gulp-zabcache
```

### manifest(options)

This controls how this task (and its helpers) operate and should contain key:value pairs, see options below.

#### options.relativePath
Type: `String`

Adds the relative path to the file to be caches with hash working as previous.

#### options.addpkgversion
Type: `boolean`

Adds the name and version of your project, taken from your package.json 

#### options.filename
Type: `String`  
Default: `"app.manifest"`

Set name of the Cache Manifest file.

#### options.cache

It is not supported in this plugin as the hash does not change with in manifest file.

#### options.exclude
Type: `String` `Array`  
Default: `undefined`  

Exclude specific files from the Cache Manifest file.

#### options.fileList
Type: `String` `Array`  
Default: `undefined` 

Adds a list of files in CACHE section

#### options.network
Type: `String` `Array`  
Default: `"*"` (By default, an online whitelist wildcard flag is added)   

Adds a string to the **NETWORK** section.

See [here](http://diveintohtml5.info/offline.html#network) for more information.

#### options.fallback
Type: `String` `Array`  
Default: `undefined`  

Adds a string to the **FALLBACK** section.

See [here](http://diveintohtml5.info/offline.html#fallback) for more information.

#### options.preferOnline
Type: `Boolean`   
Default: `undefined`

Adds a string to the **SETTINGS** section, specifically the cache mode flag of the ```prefer-online``` state.

See [here](http://www.whatwg.org/specs/web-apps/current-work/multipage/offline.html#concept-appcache-mode-prefer-online) for more information.

#### options.timestamp
Type: `Boolean`   
Default: `true` 

Adds a timestamp as a comment for easy versioning.

Note: timestamp will invalidate application cache whenever cache manifest is rebuilt, even if contents of files in `src` have not changed.

#### options.hash
Type: `Boolean`
Default: `false`

Adds a sha256 hash of all `src` files (actual contents) as a comment.

This will ensure that application cache invalidates whenever actual file contents change (it's recommented to set `timestamp` to `false` when `hash` is used).

#### options.indexfile
Type: `String`
Default: `undefined`

set your index.html file if you want to add manifest attribute

#### options.indexroot
Type: `String`
Default: `undefined`

if index.html is not in the root of your project, set the path here

### Usage Example


    gulp.task('manifest', function(){
      gulp.src(['../client/resources/build/**/*'])
        .pipe(manifest({
	        relativePath: '/resources/build'
          hash: true,
          preferOnline: true,
          network: ['http://*', 'https://*', '*'],
          addpkgversion: true,
          filelist: ['abc.css', '/lib/cordova.js'],
          filename: 'app.manifest',
          exclude: 'app.manifest'
         }))
        .pipe(gulp.dest('build'));
    });


### Output example

    CACHE MANIFEST

    CACHE:
    /resources/build/js/app.js
    /resources/build/css/style
    /resources/build/css/style.css
    /resources/build/js/zepto.min.js
    /resources/build/js/script.js
    /resources/build/some_files/index.html
    /resources/build/some_files/about.html

    NETWORK:
    http://*
    https://*
    *

    # hash: 76f0ef591f999871e1dbdf6d5064d1276d80846feeef6b556f74ad87b44ca16a


You do need to be fully aware of standard browser caching.
If the files in **CACHE** are in the network cache, they won't actually update,
since the network cache will spit back the same file to the application cache.
Therefore, it's recommended to add a hash to the filenames's, akin to rails or yeoman. See [here](http://www.stevesouders.com/blog/2008/08/23/revving-filenames-dont-use-querystring/) why query strings are not recommended.

---
_Source: https://npm.io/package/gulp-zabcache · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._