svg-optimizer

0.0.13 • Public • Published

svg-optimizer

A simple npm package for shuffling duplicated ids within the folder(including sub-folders).

svg-optimizer folder=./folder
or
svg-optimizer file=./example.svg

Installing

$ npm install svg-optimizer --save-dev

After installation, you can write the following into scripts of you project's package.json.

Script Usage

1 add a package.json, run the following at your root folder

$ npm init

you can hit enter to use all default setting.

2 add scripts on package.json.

"scripts"{
  "svg-folder": "svg-optimizer folder='./folder'",
  "svg-file": "svg-optimizer file='./example.svg'"
},

3 run the scripts

$ npm run svg-folder
or
$ npm run svg-file

folder means the root folder you want to pass. It will automatically traverse all its sub-folders and find out all svg files, making them have DIFFERENT IDs with each other (as long as they have different filenames). It also support pause / resume (just simply press ctrl + C and run the same script again)! In case you want to stop for some reason during the optimization.

file means the specific svg file you want to pass. It will only shuffle IDs within this file. If there is a space in the path file, please add '' to wrap it. Also, you can use , to pass multiple files.

Pre-commit Check Usage

You can even add it with git hook, so that every time when you check-in your code, it will automatically optimize all newly added / modified svg files for you.

Simply have a look https://github.com/ibio/svg-optimizer/blob/master/example/pre-commit-package.json and rename it as package.json, change the places whenever necessary.

Readme

Keywords

Package Sidebar

Install

npm i svg-optimizer

Weekly Downloads

2

Version

0.0.13

License

MIT

Last publish

Collaborators

  • ibio