# grunt-workbox

> Grunt plugin for integrating Workbox

Latest version **1.0.3** (published 2023-10-31) · 0 weekly downloads

## Install

```sh
npm install grunt-workbox
pnpm add grunt-workbox
yarn add grunt-workbox
bun add grunt-workbox
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2023-10-31 |
| First published | 2020-12-04 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | * |
| Dependencies | 2 |
| Unpacked size | 7.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Niels Leenheer |
| Maintainers | nielsleenheer |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-workbox
- Repository: https://github.com/NielsLeenheer/grunt-workbox
- Issues: https://github.com/NielsLeenheer/grunt-workbox/issues
- npm.io page: https://npm.io/package/grunt-workbox

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [workbox-build](https://npm.io/package/workbox-build.md) ^6.4.2

## Recent versions

- 1.0.3 (latest) — 2023-10-31
- 1.0.2 — 2021-12-03
- 1.0.1 — 2021-12-03
- 1.0.0 — 2020-12-04

## README

# grunt-workbox

> Grunt plugin for integrating Workbox

### Grunt
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-workbox --save-dev
```

One the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-workbox');
```

## Tasks

### Overview
In your project's Gruntfile, add a section named `generateSW`, `injectManifest` or `copyWorkboxLibraries` to the data object passed into `grunt.initConfig()`.

### The "generateSW" task

```js
grunt.initConfig({
    generateSW: {
        default: {
            swDest: 'dist/web/sw.js',
            globDirectory: 'dist/web',
            globPatterns: ['**/*.{js,css,html,png}']
        }
    }
})
```

This task creates a list of URLs to precache, referred to as a "precache manifest", based on the options you provide.

It also takes in additional options that configures the service worker's behavior, like any `runtimeCaching` rules it should use.

Based on the precache manifest and the additional configuration, it writes a ready-to-use service worker file to disk at `swDest`.

The options for this task are documented in the [Workbox Reference Docs](https://developers.google.com/web/tools/workbox/reference-docs/latest/module-workbox-build). Please read their documentation carefully. 


### The "injectManifest" task

```js
grunt.initConfig({
    injectManifest: {
        default: {
            swSrc: 'dist/web/sw.js.template',
            swDest: 'dist/web/sw.js',
            injectionPoint: '<% MANIFEST FILES %>',
            globDirectory: 'dist/web',
            globPatterns: ['**/*.{js,css,html,png}']
        }
    }
})
```

This task creates a list of URLs to precache, referred to as a "precache manifest", based on the options you provide.

The manifest is injected into the `swSrc` file, and the placeholder string `injectionPoint` determines where in the file the manifest should go.

The final service worker file, with the manifest injected, is written to disk at `swDest`.

The options for this task are documented in the [Workbox Reference Docs](https://developers.google.com/web/tools/workbox/reference-docs/latest/module-workbox-build). Please read their documentation carefully. 


### The "copyWorkboxLibraries" task

```js
grunt.initConfig({
    copyWorkboxLibraries: {
        default: {
            destDirectory: 'dist/web',
        }
    }
})
```

This task copies over a set of runtime libraries used by Workbox into a local directory, which should be deployed alongside your service worker file.

As an alternative to deploying these local copies, you could instead use Workbox from its official CDN URL.

This method is exposed for the benefit of developers using `injectManifest()` who would prefer not to use the CDN copies of Workbox. Developers using `generateSW()` don't need to explicitly use this task.

The options for this task are documented in the [Workbox Reference Docs](https://developers.google.com/web/tools/workbox/reference-docs/latest/module-workbox-build). Please read their documentation carefully.

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