# grunt-static-cache-buster

> Cache busts static files and updates their references

Latest version **0.1.3** (published 2015-10-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install grunt-static-cache-buster
pnpm add grunt-static-cache-buster
yarn add grunt-static-cache-buster
bun add grunt-static-cache-buster
```

## 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.1.3 |
| Published | 2015-10-05 |
| First published | 2015-10-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | valter santos matos |
| Maintainers | valter.santos.matos |
| Keywords | grunt, cache, buster, busting |

## Links

- npm: https://www.npmjs.com/package/grunt-static-cache-buster
- Repository: https://github.com/ValterSantosMatos/grunt-static-cache-buster
- Homepage: https://github.com/ValterSantosMatos/grunt-static-cache-buster#readme
- Issues: https://github.com/ValterSantosMatos/grunt-static-cache-buster/issues
- npm.io page: https://npm.io/package/grunt-static-cache-buster

## 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.1.3 (latest) — 2015-10-05
- 0.0.2 — 2015-10-04
- 0.0.1 — 2015-10-01

## README

# grunt-static-cache-buster

> Cache busts static files and updates their references

## Getting Started
This plugin requires 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-static-cache-buster --save-dev
```

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

```js
grunt.loadNpmTasks('grunt-static-cache-buster');
```

## The "static_cache_buster" task

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

```js
grunt.initConfig({
  static_cache_buster: {
    src: 'tmp/**/**.js',
    options: {
        filesToUpdateReferences: [
            'tmp/test/fixtures/file-to-bust.html',
        ],
    }
  },
})
```

### Options

#### filesToUpdateReferences
Type: `Array`
Default value: `[]`

An array containing the files whose references will be updated.
```html
    <!-- Turn this -->
    <script type="text/javascript" src="file-to-bust.js"></script>
    <!-- Into this -->
    <script type="text/javascript" src="file-to-bust-79d310bfe9ba9930c28043700467788e.js"></script>
```

### Usage Examples

#### Basic usage
In this example, the source files will be busted by calculating the md5 and appendig it to the name like: 'file-to-bust.js' into 'file-to-bust-79d310bfe9ba9930c28043700467788e.js'. 

```js
grunt.initConfig({
  static_cache_buster: {
    src: 'file-to-bust.js'
})
```

#### With filesToUpdateReferences Option
In this example, the sources files will be busted and the refences will be updated.

```js
grunt.initConfig({
  static_cache_buster: {
    src: '**/*.js',
    options: {
        filesToUpdateReferences: [
            '**/*.html',
        ],
    }
})
```

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History
**v0.1.3** - 2015-10-05
* Reviewed the regex.

**v0.1.2** - 2015-10-04
* Reviewed the regex to update the files references.

**v0.1.1** - 2015-10-01
* Publish the busting task.

## License
Copyright (c) 2015 valter santos matos. Licensed under the MIT license.

## Credits
This plugin was inspired by [grunt-cache-busting](https://github.com/PaulTondeur/grunt-cache-busting)

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