npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mifi/icon-gen

v2.1.1

Published

Generate an icon files from the SVG or PNG files

Downloads

4

Readme

@mifi/npm-icon-gen

Fork of https://github.com/akabekobeko/npm-icon-gen using sharp instead of PhantomJS

Support Node of LTS npm version test

Generate an icon files from the SVG or PNG files.

Support formats

Supported the output format of the icon are following.

| Platform | Icon | | -------: | ----------------------------------- | | Windows | app.ico or specified name. | | macOS | app.icns or specified name. | | Favicon | favicon.ico and favicon-XX.png. |

Installation

$ npm install @mifi/icon-gen

Usage

SVG and PNG are automatically selected from the input path. If the path indicates a file SVG, if it is a directory it will be a PNG folder.

SVG

SVG files are rendering to PNG file in svg2png. Rendering files is output to a temporary directory of the each OS.

Rendering of svg2png is run by phantomjs. Please use the PNG directory If the rendering quality there is a problem.

const icongen = require('@mifi/icon-gen')

icongen('./sample.svg', './icons', { report: true })
  .then((results) => {
    console.log(results)
  })
  .catch((err) => {
    console.error(err)
  })

PNG

Generate an icon files from the directory of PNG files.

const icongen = require('@mifi/icon-gen');

icongen('./images', './icons', { report: true })
.then((results) => {
  console.log(results);
} )
.catch((err) => {
  console.error(err);
});

Required PNG files is below. Favicon outputs both the ICO and PNG files (see: audreyr/favicon-cheat-sheet).

| Name | Size | ICO | ICNS | Fav ICO | Fav PNG | | -------: | --------: | :------: | :------: | :------: | :------: | | 16.png | 16x16 | ✔ | ✔ | ✔ | | | 24.png | 24x24 | ✔ | | ✔ | | | 32.png | 32x32 | ✔ | ✔ | ✔ | ✔ | | 48.png | 48x48 | ✔ | | ✔ | | | 57.png | 57x57 | | | | ✔ | | 64.png | 64x64 | ✔ | ✔ | ✔ | | | 72.png | 72x72 | | | | ✔ | | 96.png | 96x96 | | | | ✔ | | 120.png | 120x120 | | | | ✔ | | 128.png | 128x128 | ✔ | ✔ | | ✔ | | 144.png | 144x144 | | | | ✔ | | 152.png | 152x152 | | | | ✔ | | 195.png | 195x195 | | | | ✔ | | 228.png | 228x228 | | | | ✔ | | 256.png | 256x256 | ✔ | ✔ | | | | 512.png | 512x512 | | ✔ | | | | 1024.png | 1024x1024 | | ✔ | | |

To make it a special size configuration, please specify with ico,icns and favicon options.

Node API

icongen

icongen is promisify function.

icongen(src, dest[, options])

| Name | Type | Description | | ------- | -------- | ---------------------------------------------------------------------------- | | src | String | Path of the SVG file or PNG files directory that becomes the source. | | dest | String | Destination directory path. | | options | Object | see: Options. |

Options:

const options = {
  report: true,
  ico: {
    name: 'app',
    sizes: [16, 24, 32, 48, 64, 128, 256]
  },
  icns: {
    name: 'app',
    sizes: [16, 32, 64, 128, 256, 512, 1024]
  },
  favicon: {
    name: 'favicon-',
    pngSizes: [32, 57, 72, 96, 120, 128, 144, 152, 195, 228],
    icoSizes: [16, 24, 32, 48, 64]
  }
}

If all image options (ico,icns, favicon) are omitted, all images are output with their default settings.

// Output an all images with default settings
const options = {
  report: true
}

If individual image option is omitted, default setting is used. If there is a format that you do not want to output, specify others and omit that image.

// Without ICNS
const options = {
  report: true,
  ico: {}
  favicon: {}
}

| Name | Type | Description | | ------- | --------- | ------------------------------------------------------------------ | | report | Boolean | Display the process reports. Default is false, disable a report. | | ico | Object | Output setting of ICO file. | | icns | Object | Output setting of ICNS file. | | favicon | Object | Output setting of Favicon file (PNG and ICO). |

ico, icns

| Name | Type | Default | Description | | ----- | ---------- | --------------- | ---------------------------- | | name | String | app | Name of an output file. | | sizes | Number[] | [Defaults...] | Structure of an image sizes. |

favicon

| Name | Type | Default | Description | | -------- | ---------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | name | String | favicon- | Prefix of an output PNG files. Start with the alphabet, can use - and _. This option is for PNG. The name of the ICO file is always favicon.ico. | | pngSizes | Number[] | [Defaults...] | Size structure of PNG files to output. | | icoSizes | Number[] | [Defaults...] | Structure of an image sizes for ICO. |

CLI

Usage:  icon-gen [options]

Generate an icon from the SVG or PNG file.
If "--ico", "--icns", "--favicon" is not specified, everything is output in the standard setting.

Options:
  -i, --input <Path>           Path of the SVG file or PNG file directory.
  -o, --output <Path>          Path of the output directory.
  -r, --report                 Display the process reports, default is disable.
  --ico                        Output ICO file with default settings, option is "--ico-*".
  --ico-name <Name>            ICO file name to output.
  --ico-sizes [Sizes]          PNG size list to structure ICO file
  --icns                       Output ICNS file with default settings, option is "--icns-*".
  --icns-name <Name>           ICO file name to output.
  --icns-sizes [Sizes]         PNG size list to structure ICNS file
  --favicon                    Output Favicon files with default settings, option is "--favicon-*".
  --favicon-name <Name>        prefix of the PNG file. Start with the alphabet, can use "-" and "_"
  --favicon-png-sizes [Sizes]  Sizes of the Favicon PNG files
  --favicon-ico-sizes [Sizes]  PNG size list to structure Favicon ICO file
  -v, --version                output the version number
  -h, --help                   output usage information

Examples:
  $ icon-gen -i sample.svg -o ./dist -r
  $ icon-gen -i ./images -o ./dist -r
  $ icon-gen -i sample.svg -o ./dist --ico --icns
  $ icon-gen -i sample.svg -o ./dist --ico --ico-name sample --ico-sizes 16,32
  $ icon-gen -i sample.svg -o ./dist --icns --icns-name sample --icns-sizes 16,32
  $ icon-gen -i sample.svg -o ./dist --favicon --favicon-name=favicon-  --favicon-png-sizes 16,32,128 --favicon-ico-sizes 16,32

See also:
  https://github.com/mifi/npm-icon-gen

ChangeLog

License