svg-sprites-cli

0.2.3 • Public • Published

svg-sprites-cli

介绍

SVG 批量转为 SVG Sprite 的小工具。

安装

全局安装:

npm install -g svg-sprites-cli

项目安装:

npm install -D svg-sprites-cli

执行指令

svgjs -d ./icons -o ./dist/svg.js

其中:

  • -d--dir: 要打包的 SVG 文件夹目录
  • -o--output: 输出的 js 文件存放地址

注:如果是项目安装只能通过写好 script 的方式运行:

package.json:

{
  "scripts": {
    "build:svg": "svgjs -d ./icons -o ./dist/svg.js"
  },
}

然后执行:

npm run build:svg

指定配置文件执行

svgjs -c ./config.js

其中:

  • -c--config: 配置的 js 文件地址

配置文件格式

config.js:

module.exports = {
  dir: './icons',
  output: './dist/svg.js',
  symbolId(id, path) {
    return id.replace('.svg', '')
  },
  eslintDisable: true
}
key 类型 必填 默认值 描述
dir string 要打包的 SVG 文件夹目录
output string 输出的 js 文件存放地址
symbolId (id: string, path: string) => string a.svg -> icon-a 转化图标 id 函数
eslintDisable string false 输出文件不做 eslint 校验

Package Sidebar

Install

npm i svg-sprites-cli

Weekly Downloads

2

Version

0.2.3

License

MIT

Unpacked Size

6.74 kB

Total Files

8

Last publish

Collaborators

  • godxiaoji