https://github.com/kaze-k/generate-icon-webpack-plugin
A webpack plugin to generate icons of different sizes
https://github.com/kaze-k/generate-icon-webpack-plugin
browser-extension cli-table favicon-generator icons-generator mkdirp sharp webpack webpack-plugin webpack5
Last synced: about 2 months ago
JSON representation
A webpack plugin to generate icons of different sizes
- Host: GitHub
- URL: https://github.com/kaze-k/generate-icon-webpack-plugin
- Owner: kaze-k
- License: mit
- Created: 2023-08-19T07:33:01.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-01T11:05:22.000Z (12 months ago)
- Last Synced: 2025-03-01T02:39:10.440Z (3 months ago)
- Topics: browser-extension, cli-table, favicon-generator, icons-generator, mkdirp, sharp, webpack, webpack-plugin, webpack5
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/generate-icon-webpack-plugin
- Size: 342 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# generate-icon-webpack-plugin
A webpack plugin to generate icons of different sizes
Images in the `icons` field and `action.default_icon` field in chrome extensions **Manifest V3** can be generated using this plugin
## Usage
add the plugin:
``` bash
npm install generate-icon-webpack-plugin --save-dev
// or
pnpm add generate-icon-webpack-plugin -D
// or
yarn add generate-icon-webpack-plugin -D
```
configure the plugin:
``` js
new CrxPackWebpackPlugin({
logo: path.resolve(__dirname, "./icon.png"),
dir: "icons",
size: [128, 64, 48, 32, 16], // 128, It can be an array or a number
format: "png",
grayscale: false,
imgName: "icon",
log: true
})
```
## Configuration Settings
| Option | Required | Type | Default | About |
|---|---|---|---|---|
| logo | yes | string | none | images that need to be converted |
| dir | no | string | "icons" | the directory for the output picture |
| size | no | number[]/number | [16, 32, 48, 64, 128] | image size, if it is a number, only one image is generated, if it is an array, it is multiple images |
| format | no | string | "png" | the format of the output picture |
| grayscale | no | boolean | false | whether to generate a gray image |
| imgName | no | string | "icon" | name of the picture |
| log | no | boolean | false | print picture information |
## Acknowledgement
Inspired by [plasmo](https://github.com/PlasmoHQ/plasmo)'s ability to generate images.