Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/steven-roberts/gulp-chrome-manifest-iconify

A gulp plugin that takes a master icon and automatically generates icon set for your Chrome extension by parsing the v2 manifest
https://github.com/steven-roberts/gulp-chrome-manifest-iconify

chrome-extension gulp gulp-plugin icons javascript manifest

Last synced: 4 days ago
JSON representation

A gulp plugin that takes a master icon and automatically generates icon set for your Chrome extension by parsing the v2 manifest

Host: GitHub
URL: https://github.com/steven-roberts/gulp-chrome-manifest-iconify
Owner: Steven-Roberts
License: mit
Created: 2016-11-20T18:11:19.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2023-01-06T16:47:35.000Z (about 2 years ago)
Last Synced: 2025-02-09T18:16:22.319Z (4 days ago)
Topics: chrome-extension, gulp, gulp-plugin, icons, javascript, manifest
Language: JavaScript
Homepage: https://www.npmjs.com/package/gulp-chrome-manifest-iconify
Size: 1.11 MB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 10
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # gulp-chrome-manifest-iconify

[![NPM version](https://img.shields.io/npm/v/gulp-chrome-manifest-iconify.svg?style=flat)](https://www.npmjs.com/package/gulp-chrome-manifest-iconify)

[![node](https://img.shields.io/node/v/gulp-chrome-manifest-iconify.svg)](https://www.npmjs.com/package/gulp-chrome-manifest-iconify)

[![Build Status](https://travis-ci.org/Steven-Roberts/gulp-chrome-manifest-iconify.svg?branch=master)](https://travis-ci.org/Steven-Roberts/gulp-chrome-manifest-iconify)

[![Coverage Status](https://coveralls.io/repos/github/Steven-Roberts/gulp-chrome-manifest-iconify/badge.svg?branch=master)](https://coveralls.io/github/Steven-Roberts/gulp-chrome-manifest-iconify?branch=master)

[![dependencies Status](https://david-dm.org/Steven-Roberts/gulp-chrome-manifest-iconify/status.svg)](https://david-dm.org/Steven-Roberts/gulp-chrome-manifest-iconify)

[![devDependencies Status](https://david-dm.org/Steven-Roberts/gulp-chrome-manifest-iconify/dev-status.svg)](https://david-dm.org/Steven-Roberts/gulp-chrome-manifest-iconify?type=dev)

A [Gulp](https://github.com/gulpjs/gulp) plugin for

[chrome-manifest-iconify](https://github.com/Steven-Roberts/chrome-manifest-iconify)

When creating a Chrome extension, you need to provide a set of icons for context menus, browser actions, page actions, and the Chrome Web Store. Usually, these are just resized versions of the same image. The goal of gulp-chrome-manifest-iconify is to intellegently automate the tedious process of generated all these resized clones. In a [Gulp](https://github.com/gulpjs/gulp) task, simply pipe this plugin a master icon and indicate the path to a v2 manifest. It will parse the manifest to determine the sizes, names, types, and paths of the icons it needs to generate. You can choose from several resizing algorithms as provide by [Sharp](https://sharp.dimens.io/en/stable/) so your entire icon set looks awesome.

## Installation

```shell

npm install --save-dev gulp-chrome-manifest-iconify

```

## API



### gulp-chrome-manifest-iconify

The gulp-chrome-manifest-iconify module

**Example**  

```js

const gulp = require('gulp');

const chromeManifestIconify = require('gulp-chrome-manifest-iconify');

gulp.task('default', () =>

    gulp.src('icon.png')

        .pipe(chromeManifestIconify({

            manifest: 'src/manifest.json',

            resizeMode: 'nearest'

        }))

        .pipe(gulp.dest('build')));

```



#### module.exports(options) ⇒ Stream ⏏

A Gulp plugin that generates icon set for a Chrome extension or app by

parsing the v2 manifest.

**Kind**: Exported function  

**Returns**: Stream - A Node stream that produces the icons  

| Param | Type | Default | Description |

| --- | --- | --- | --- |

| options | object |  | The options for generating the icons |

| [options.manifest] | string | "manifest.json" | The path to the v2 manifest.json |

| [options.resizeMode] | string |  | The name of a [Sharp kernel](https://sharp.pixelplumbing.com/api-resize#resize) |