Giter Club home page Giter Club logo

icomoon-cli's Introduction

icomoon-cli

icomoon-cli is a cross platform command line tool which help you upload your new icons into an existed icomoon set.

Since icomoon do not provide any public API to use, you may found it's hard to integrate icomoon into your current workflow. icomoon-cli was made to solve this.

dependencies

icomoon-cli will use your local Chrome to interact with icomoon in headless mode, so you need to make sure the latest version Chrome browser was installed.

Another dependency is the LTS version Node.js.

cli usage

If you like to use icomoon-cli as a cli, simply installed it via npm and use with following commands

Install: npm i -g icomoon-cli

Usage: icomoon-cli [command]
Commands:
  --version        output the version number
  -h, --help       output usage information
  -i, --icons      paths to icons need to be imported, separated by comma
  -s, --selection  path to icomoon selection file
  -n, --names      rename icons, separated by comma, matched by index
  -o, --output     output directory
  -f, --force      force override current icon when icon name duplicated
  -v, --visible    run a GUI chrome instead of headless mode

Example Usage: icomoon-cli -i test-assets/1.svg,test-assets/2.svg -s test-assets/selection.json -n newname1,newname2 -o output

programmatic usage

If you like to integrate icomoon-cli into your workflow, it's recommended to use in the programmatic way

// Install: npm i icomoon-cli

// Usage
const pipeline = require('icomoon-cli');
pipeline({
  icons: ['test-assets/1.svg', 'test-assets/2.svg'],
  names: ['new1', 'new2'],
  selectionPath: 'test-assets/selection.json',
  outputDir: 'output',
  forceOverride: true,
  // visible: true,
  whenFinished (result) {
    // you can get the absolute path of output directory via result.outputDir
  }
});

You can hack the downloaded icomoon files in a callback property whenFinished, or just use Promise to control your code since pipeline will return a promise.

icomoon-cli's People

Contributors

qkdreyer avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.