前言
因为公司电脑太过辣鸡的原因，导致每次运行webpack的时候等待时间太慢（有时候甚至窗口停止工作T_T）。为了解决这个问题并提升工作效率，打算把这个前端项目从vuecli移植到vite（2.0）上。但是在技术调研的过程中发现，svg-sprite-loader还没有支持vite（icon都是用svg引入的），所以只能自己写一个vite的plugin了。
原理
要想自己写，得先了解svg在html中的使用。
SVG
svg（Scalable Vector Graphics）是一种web矢量图形语言，这意味着它不会因为自由放大缩小而导致图像失真，比较常用于icon展示。（当然，使用svg还有更多好处，具体可以看这里）
在html中引入和使用svg
在html中引入svg，一般是先将多个svg转换成多个symbol并标上id，然后将多个symbol嵌入到svg标签当中，最后塞入body标签中，效果如下图
引入的时候只需要利用use标签引入相应的id就好了
而svg-sprite-lodaer正是帮我们把以上手动操作通过node.js批量引入。
实现
了解原理之后当然就是开始写了。
利用node.js批量读取svg文件
用深度遍历把文件夹下的svg文件内容读出来，处理完后把结果保存到一个数组里面。
import { readFileSync, readdirSync } from 'fs'
// id 前缀
let idPerfix = ''
// 识别svg标签的属性
const svgTitle = /<svg([^>+].*?)>/
// 有一些svg文件的属性会定义height和width，要把它清除掉
const clearHeightWidth = /(width|height)="([^>+].*?)"/g
// 没有viewBox的话就利用height和width来新建一个viewBox
const hasViewBox = /(viewBox="[^>+].*?")/g
// 清除换行符
const clearReturn = /(\r)|(\n)/g
/**
* @param dir 路径
*/
function findSvgFile(dir: string): string[] {
const svgRes: string[] = []
const dirents = readdirSync(dir, {
withFileTypes: true
})
for (const dirent of dirents) {
const path = dir + dirent.name
if (dirent.isDirectory()) {
svgRes.push(...findSvgFile(path + '/'))
} else {
const svg = readFileSync(path)
.toString()
.replace(clearReturn, '')
.replace(svgTitle, ($1, $2) => {
let width = 0
let height = 0
let content = $2.replace(
clearHeightWidth,
(s1, s2, s3) => {
s3 = s3.replace('px', '')
if (s2 === 'width') {
width = s3
} else if (s2 === 'height') {
height = s3
}
return ''
}
)
if (!hasViewBox.test($2)) {
content += `viewBox="0 0 ${width} ${height}"`
}
return `<symbol id="${idPerfix}-${dirent.name.replace(
'.svg',
''
)}" ${content}>`
})
.replace('</svg>', '</symbol>')
svgRes.push(svg)
}
}
return svgRes
}
插入到html的body中
利用vite中plugin提供的transformIndexHtml钩子函数就能读取到html源文件了。
import { Plugin } from 'vite'
···
export const svgBuilder = (path: string, perfix = 'icon'): Plugin => {
if (path === '') return
idPerfix = perfix
const res = findSvgFile(path) //引用上面的
return {
name: 'svg-transform',
transformIndexHtml(html): string {
return html.replace(
'<body>',
`
<body>
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position: absolute; width: 0; height: 0">
${res.join('')}
</svg>
`
)
}
}
}
最后在vite.config.ts中引入。
import type { UserConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import { svgBuilder } from './build/svg/svgBuilder'
export default (
mode: 'development' | 'production'
): UserConfig => {
...
return {
plugins: [vue(), svgBuilder('./src/icons/svg/')],
...
}
}
结语
虽然比较简单，但能帮到人真的是太好了（还能水文章）。
