# perfume-webpack-plugin

> A Webpack plugin to perfume.js

Latest version **1.0.3** (published 2020-04-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install perfume-webpack-plugin
pnpm add perfume-webpack-plugin
yarn add perfume-webpack-plugin
bun add perfume-webpack-plugin
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2020-04-29 |
| First published | 2020-02-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=10.0.0 |
| Dependencies | 7 |
| Unpacked size | 1.3 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | evanzhou |
| Maintainers | zy308718320 |
| Keywords | perfume.js, performance-metrics, webpack-plugin, web-performance |

## Links

- npm: https://www.npmjs.com/package/perfume-webpack-plugin
- Repository: https://github.com/zy308718320/perfume-webpack-plugin
- Homepage: https://github.com/zy308718320/perfume-webpack-plugin#readme
- Issues: https://github.com/zy308718320/perfume-webpack-plugin/issues
- npm.io page: https://npm.io/package/perfume-webpack-plugin

## Dependencies (7)

- [acorn](https://npm.io/package/acorn.md) ^7.1.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [webpack](https://npm.io/package/webpack.md) ^4.41.5
- [escodegen](https://npm.io/package/escodegen.md) ^1.14.1
- [acorn-walk](https://npm.io/package/acorn-walk.md) ^7.0.0
- [perfume.js](https://npm.io/package/perfume.js.md) ^4.8.0
- [fingerprintjs2](https://npm.io/package/fingerprintjs2.md) ^2.1.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2020-04-29
- 1.0.2 — 2020-04-29
- 1.0.1 — 2020-04-08
- 1.0.0 — 2020-02-18

## README

# perfume-webpack-plugin

[![Build Status](https://travis-ci.com/zy308718320/perfume-webpack-plugin.svg?branch=master)](https://travis-ci.com/zy308718320/perfume-webpack-plugin)
[![Coverage Status](https://coveralls.io/repos/github/zy308718320/perfume-webpack-plugin/badge.svg?branch=master)](https://coveralls.io/github/zy308718320/perfume-webpack-plugin?branch=master)
![GitHub](https://img.shields.io/github/license/zy308718320/perfume-webpack-plugin)
![GitHub package.json version](https://img.shields.io/github/package-json/v/zy308718320/perfume-webpack-plugin)

A Webpack plugin to [perfume.js](https://github.com/Zizzamia/perfume.js)

English | [简体中文](./README-zh_CN.md)

## Installation:

First things first, install the module:

```console
npm i perfume-webpack-plugin -D
```
### Importing library
```javascript
import PerfumeWebpackPlugin from 'perfume-webpack-plugin'
```
### If using CommonJS import
```javascript
const PerfumeWebpackPlugin = require('perfume-webpack-plugin').default
```

## Example:

```javascript
const apiKey = 'xxx'
module.exports = {
  plugins: [
    new PerfumeWebpackPlugin({
      entry: /app\.js$/,
      fps: true,
      dataConsumption: true,
      resourceTiming: true,
      cumulativeLayoutShift: true,
      isMerge: true,
      reportUrl: `https://example.com/report?apiKey=${apiKey}`,
      ignoreResource: [{ key: 'name', value: '/report' }],
      logging: false,
    })
  ]
}
```

## Default Options:
```javascript
const options = {
  entry: /app\.js$/,
  // Metrics
  fps: false,
  dataConsumption: false,
  resourceTiming: false,
  cumulativeLayoutShift: false,
  // Analytics
  tag: '',
  reportUrl: '',
  ignoreResource: [],
  isMerge: false,
  analyticsTracker: option => {},
  // Logging
  logPrefix: 'Perfume.js:',
  logging: true,
  maxMeasureTime: 15000,
};

```

## License

#### [MIT](./LICENSE)

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