# crx-pack-webpack-plugin

> A webpack5 plugin to pack crx

Latest version **1.1.1** (published 2023-08-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install crx-pack-webpack-plugin
pnpm add crx-pack-webpack-plugin
yarn add crx-pack-webpack-plugin
bun add crx-pack-webpack-plugin
```

## 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.1.1 |
| Published | 2023-08-23 |
| First published | 2023-08-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | kaze-k |
| Maintainers | kaze-k |
| Keywords | webpack, plugin, crx3, node |

## Links

- npm: https://www.npmjs.com/package/crx-pack-webpack-plugin
- Repository: https://github.com/kaze-k/crx-pack-webpack-plugin
- Issues: https://github.com/kaze-k/crx-pack-webpack-plugin/issues
- npm.io page: https://npm.io/package/crx-pack-webpack-plugin

## Dependencies (3)

- [crx3](https://npm.io/package/crx3.md) ^1.1.3
- [mkdirp](https://npm.io/package/mkdirp.md) ^3.0.1
- [colors-console](https://npm.io/package/colors-console.md) ^1.0.3

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2023-08-23
- 1.1.0 — 2023-08-21
- 1.0.1 — 2023-08-15

## README

# crx-pack-webpack-plugin

A webpack5 plugin to pack crx, use [crx3](https://github.com/ahwayakchih/crx3) and support typescript.

## Usage

add the plugin:

``` js
yarn add crx-pack-webpack-plugin -D
```

configure the plugin:

``` js
new CrxPackWebpackPlugin({
  zip: true,
  xml: true,
  keyFile: "your-private-key.pem",
  contentPath: "./build",
  outputPath: "./release",
  updateURL: "http://localhost:8080",
  updateFilename: "update.xml",
  name: "example-name",
  autoClean: true,
})
```

## Configuration Settings

| Option | Required | Type | Default | About |
|---|---|---|---|---|
| zip | no | boolean | true | provides a zip of the build files along with the CRX. |
| xml | no | boolean | true | provides a xml of the build files along with the CRX. |
| keyFile | yes | string | none | a private key required to update the extension. |
| contenPath | yes | string | none | location of build files. |
| outputPath | yes | string | none | where to export the built extension. |
| updateURL | no | string | "http://localhost:8000/" | where to find updates.xml |
| updateFilename | no | string | "update.xml" | filename for update.xml |
| name | no | string | "package" | the name of the built extension. |
| autoClean | no | boolean | false | whether to automatically empty files |

## Alternatives

- [crx-webpack-plugin](https://github.com/johnagan/crx-webpack-plugin)
- [crx3-webpack-plugin](https://github.com/garrettlr/crx3-webpack-plugin)

Thank them for their inspiration

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