# broccoli-gzip

> Broccoli plugin to gzip files.

Latest version **0.3.0** (published 2017-03-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install broccoli-gzip
pnpm add broccoli-gzip
yarn add broccoli-gzip
bun add broccoli-gzip
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2017-03-31 |
| First published | 2014-05-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Dan Freeman |
| Maintainers | dfreeman |
| Keywords | broccoli-plugin, gzip |

## Links

- npm: https://www.npmjs.com/package/broccoli-gzip
- Repository: https://github.com/salsify/broccoli-gzip
- Homepage: https://github.com/salsify/broccoli-gzip#readme
- Issues: https://github.com/salsify/broccoli-gzip/issues
- npm.io page: https://npm.io/package/broccoli-gzip

## Dependencies (3)

- [rsvp](https://npm.io/package/rsvp.md) ^3.3.3
- [broccoli-filter](https://npm.io/package/broccoli-filter.md) ^1.2.4
- [broccoli-kitchen-sink-helpers](https://npm.io/package/broccoli-kitchen-sink-helpers.md) ^0.3.1

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 0.3.0 (latest) — 2017-03-31
- 0.2.0 (0.2.0) — 2014-06-22
- 0.2.1 — 2015-04-03
- 0.1.0 — 2014-05-13

## README

# Broccoli Gzip Plugin

[![Build Status](https://travis-ci.org/salsify/broccoli-gzip.svg?branch=master)](https://travis-ci.org/salsify/broccoli-gzip)

## Installation

```bash
yarn add broccoli-gzip
```

## Example

```javascript
const Gzip = require('broccoli-gzip');

let tree = new Gzip('app', {
  extensions: ['js', 'css']
});
```

## Configuration

### `new Gzip(inputTree, options)`

---

`options.extensions` *{Array}* (Required)

The file extensions that should be compressed.

---

`options.keepUncompressed` *{Boolean}* (Optional, default `false`)

Whether the uncompressed versions of the files should be kept in the resulting tree.

---

`options.appendSuffix` *{Boolean}* (Optional, default `true`)

Whether to append the .gz suffix.

## Testing

```bash
yarn test
```

## License

This project is distributed under the MIT license.

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