sw-precache-brunch
Version:
Adds offline first approach support to brunch.
111 lines (80 loc) • 2.47 kB
Markdown
## sw-precache-brunch [](https://travis-ci.org/denar90/sw-precache-brunch)
Adds [Service Worker Precache](https://github.com/GoogleChrome/sw-precache) support to
[brunch](http://brunch.io).
## Usage
Install the plugin via npm with `npm install --save-dev sw-precache-brunch`.
Or, do manual install:
* Add `"sw-precache-brunch": "~x.y.z"` to `package.json` of your brunch app.
* If you want to use git version of plugin, use the GitHub URI
`"sw-precache-brunch": "denar90/sw-precache-brunch"`.
[Project example of it's usage](https://github.com/denar90/brunch-with-marionettejs)
## Configuration
##### swFileName [String]
Filename for service worker.
> It will be placed into destination (public) brunch folder.
*Default:* `'sw.js'`
##### autorequire [Boolean, Array]
This option gives possibility to add and register
service worker into `html` asset files.
> If value set as `true` service worker will be added and registered to ALL `html` assets automatically.
Config example:
```js
swPrecache: {
'swFileName': 'service-worker.js',
'autorequire': true
}
```
```js
swPrecache: {
'autorequire': ['app/assets/index.html']
}
```
*Default:* `false`
##### options [Object]
Options for `sw-precache`.
Look at all `sw-precache` available [options](https://github.com/GoogleChrome/sw-precache#options-parameter).
*Default:* `{staticFileGlobs: ['public/**/*.*']}`
> If you don't pass any configuration properties it will cache all files in your `public` folder and create `sw.js`.
All what you need is [register service worker](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration) for your app.
###Config example
```js
module.exports = {
files: {
javascripts: {
joinTo: {
'vendor.js': /^(?!app|test)/,
'app.js': /^app/,
'test.js': /^test/
}
},
stylesheets: {joinTo: 'app.css'},
},
plugins: {
babel: {presets: ['es2015']},
swPrecache: {
swFileName: 'service-worker.js',
options: {
staticFileGlobs: [
'public/app.css',
'public/app.js',
'public/index.html'
],
stripPrefix: 'public/'
}
}
}
};
```
```js
module.exports = {
plugins: {
...
swPrecache: {
autorequire: ['app/assets/index.html']
}
...
}
};
```
## License
MIT © [Artem Denysov](https://github.com/denar90)