·19 分钟阅读·管理员
写个vite插件玩玩
该自定义Vite插件用于灵活处理SVG文件导入,结合svgo对SVG进行压缩优化。插件支持四种导入模式:默认URL导入、作为Vue组件导入(可配置是否经svgo处理)、跳过svgo处理的组件导入,以及原始数据导入。其核心原理是通过正则匹配路径,在load钩子中读取文件,利用svgo优化代码,并借助vue/compiler-sfc将SVG编译为Vue组件。此外,开发过程还提供了配套的TypeScript类型声明配置,以解决ESLint和TS校验报错,并附带完整代码与使用示例,帮助开发者高效集成SVG资源。
Vite
写个vite插件玩玩儿
分析
通过配置文件定义插件功能,结合svgo对svg做一些压缩裁剪等功能
- 通过默认导入,也就是默认作为URL,不会经过
svgo处理,即作为基本的URL, 如<img src="xxxx.svg" /> - 通过
xxx.svg?component导入,useSvgo为false/true,(不)/经过svgo处理,以组件方式使用 - 通过
?skipSvgo导入,不经过svgo处理,以组件方式使用,会覆盖useSvgo配置 - 通过
?raw导入,使用svg原数据
其实不用svgo处理svg也是可以的,只是svgo能够对svg进行“清理”一些不需要的,或许会更友好一些。
安装依赖
bash
npm install debug svgo @types/node @types/debug --save-dev
这debug依赖可选,主要用于调试而已
创建插件
在跟目录下创建一个名为plugins目录,再该目录下创建文件svg-import.ts
添加配置类型
typescript
export interface ISvgImport {
/**
* 是否使用svgo处理
* @default false
*/
useSvgo?: boolean;
/**
* svgo配置
* @see https://svgo.dev/
*/
svgoConfig?: Config;
/**
* 默认导入类型
* @default url
*/
defaultImport?: 'url' | 'component' | '!svgo' | 'svgo';
}
匹配路径
通过正则匹配一个文件的路径是否包含以以上规则组成
typescript
// 正则匹配,匹配以.svg为后缀名,可以包含如?raw等为命名
const svgRegex = /\.svg(\?(url|raw|component|(!svgo)))?$/;
功能实现
关于vite插件的相关钩子,在这篇简单认识vite已经介绍过,这里不再介绍。
根据需要,只需要在vite的load钩子中实现逻辑即可。
-
通过URL导入的方式(即默认导入)
typescript/** * 定义插件 * @param options */ export function svgImport(options: ISvgImport = {}): Plugin { // 默认配置 const opts: ISvgImport = { useSvgo: false, defaultImport: 'url', ...options }; // 解构配置参数 const { useSvgo, svgoConfig, defaultImport } = opts; return { // 插件名称 name: 'vite-plugin-svg-import', // 需要在vite核心插件之前调用 enforce: 'pre', // id 表示导入模块的路径 load: id => { // 匹配路径,没有匹配到,提前返回 if (!id.match(svgRegex)) { return; } // 提取前缀路径和可选条件 const [path, query] = id.split('?', 2); // 导入类型 const importType = query || defaultImport; // 如果是以URL的形式导入 if (importType === 'url') { return; } } }; } -
通过原始数据导入(?raw)
typescriptlet svg; const debug = _debug('vite-plugin-svg-import'); try { // 使用node fs读取该路径源文件内容 svg = await fs.readFile(path, 'utf-8'); } catch (error) { debug('\n', `${id} loaded error: ${error}`); return; } // 如果是原始数据,直接以默认的方式导出 if (importType === 'raw') { return `export default ${JSON.stringify(svg)}`; } -
使用svgo处理
typescript// 导入类型是svgo 会覆盖全局配置useSvgo // 或者没有配置!svgo,使用useSvgo配置,!!useSvgo && importType !== 'skipSvgo' 相当于就是useSvgo=true,xxx.svg?component if (importType === 'svgo' || (!!useSvgo && importType !== 'skipSvgo')) { // 使用svgo处理svg svg = svgOptimize(svg, { ...svgoConfig, path }).data; } -
编译代码
typescript// 使用vue/compiler-sfc模块中compileTemplate,把单文件组件编译成为js代码 const { code } = compileTemplate({ // 模块的路径 id: JSON.stringify(id), // 该模块的源代码 source: svg, // 文件名,如xxx.vue,这里是xxx.svg filename: path, // 配置是否需要转换为assets url导入的标记属性,这里不需要,所以false即可 transformAssetUrls: false }); // 需要一个默认导出,否则会报错没有默认导出 return `${code}\nexport default { render: render }`;简单介绍一下compileTemplate方法,就是将一个源代码文件(单文件组件)编译成js代码,也就是一个render函数,生成的代码示例如下:
typescriptimport { createElementVNode as _createElementVNode, openBlock as _openBlock, createElementBlock as _createElementBlock } from "vue" export function render(_ctx, _cache) { return (_openBlock(), _createElementBlock("svg", _hoisted_1, _cache[0] || (_cache[0] = [ _createElementVNode("path", { fill: "#41B883", d: "M204.8 0H256L128 220.8 0 0h97.92L128 51.2 157.44 0z" }, null, -1 /* HOISTED */), _createElementVNode("path", { fill: "#41B883", d: "m0 0 128 220.8L256 0h-51.2L128 132.48 50.56 0z" }, null, -1 /* HOISTED */), _createElementVNode("path", { fill: "#35495E", d: "M50.56 0 128 133.12 204.8 0h-47.36L128 51.2 97.92 0z" }, null, -1 /* HOISTED */) ]))) }具体可以查看源代码vue/compiler-sfc
使用插件
typescript
// vite.config.ts
import vue from '@vitejs/plugin-vue';
import { defineConfig } from 'vite';
import { svgImport } from './plugins/svg-import.ts';
// https://vite.dev/config/
export default defineConfig({
plugins: [vue(), svgImport()]
});
vue
// 组件形式
<script setup lang="ts">
import svgCom from '../assets/vue.svg?component';
</script>
<template>
<div>
<h1>组件形式</h1>
<svgCom />
</div>
</template>
// 原始数据
<script setup lang="ts">
import svgRaw from '../assets/vue.svg?raw';
</script>
<template>
<div>
<h1>原始数据</h1>
{{ svgRaw }}
</div>
</template>
// 跳过svgo
<script setup lang="ts">
import SvgSkipSvgo from '../assets/vue.svg?skipSvgo';
</script>
<template>
<div>
<h1>跳过svgo处理</h1>
<SvgSkipSvgo />
</div>
</template>
<style lang="scss"></style>
// 使用svgo
<script setup lang="ts">
import SvgSvgo from '../assets/vue.svg?svgo';
</script>
<template>
<div>
<h1>使用svgo处理</h1>
<SvgSvgo />
</div>
</template>
// 默认
<script setup lang="ts">
import svgUrl from '../assets/vue.svg';
</script>
<template>
<div>
<h1>URL形式</h1>
<img :src="svgUrl" alt="" />
</div>
</template>
vue
// App.vue
<script setup lang="ts">
import SvgCom from './components/SvgCom.vue';
import SvgRaw from './components/SvgRaw.vue';
import SvgSkipSvgo from './components/SvgSkipSvgo.vue';
import SvgSvgo from './components/SvgSvgo.vue';
import SvgURL from './components/SvgURL.vue';
</script>
<template>
<div style="display: flex; justify-content: center; align-items: center; height: 800px">
<div style="width: 800px">
<SvgURL />
<SvgCom />
<SvgRaw />
<SvgSvgo />
<SvgSkipSvgo />
</div>
</div>
</template>
<style scoped></style>

解决eslint校验问题
在使用上面的示例中,如果配置有eslint检验或者ts校验,会报类型错误
新建svg-import.d.ts,在vite-env.d.ts中添加
typescript
/// <reference types="vite/client" />
/// <reference types="./svg-import" />
typescript
// svg-import.d.ts
declare module 'vite-plugin-svg-import' {
import type { Config } from 'svgo';
import type { Plugin } from 'vite';
function svgImport(options?: {
svgoConfig?: Config;
useSvgo?: boolean;
defaultImport?: 'url' | 'component' | 'skipSvgo' | 'svgo';
}): Plugin;
export default svgImport;
}
declare module '*.svg?component' {
import type { FunctionalComponent, SVGAttributes } from 'vue';
const src: FunctionalComponent<SVGAttributes>;
export default src;
}
declare module '*.svg?url' {
const src: string;
export default src;
}
declare module '*.svg?raw' {
const src: string;
export default src;
}
declare module '*.svg?svgo' {
import type { FunctionalComponent, SVGAttributes } from 'vue';
const src: FunctionalComponent<SVGAttributes>;
export default src;
}
declare module '*.svg?skipSvgo' {
import type { FunctionalComponent, SVGAttributes } from 'vue';
const src: FunctionalComponent<SVGAttributes>;
export default src;
}
注意:不能在同一个文件下导入,否则会报多次导入文件错误
完整代码
typescript
import fs from 'fs/promises';
import _debug from 'debug';
import { optimize as svgOptimize, type Config } from 'svgo';
import { compileTemplate } from 'vue/compiler-sfc';
import type { Plugin } from 'vite';
/**
* useSvgo 配置全局是否经过svgo处理,?(!)svgo覆盖前置
* 1. 通过默认导入,也就是默认作为URL,不处理
* 2.通过?component导入,useSvgo为false/true,(不)/经过svgo处理,以组件方式处理
* 3.通过?!svgo导入,不经过svgo处理,以组件方式处理
* 4.通过?raw导入,使用svg原数据
*/
export interface ISvgImport {
/**
* 是否使用svgo处理
* @default false
*/
useSvgo?: boolean;
/**
* svgo配置
* @see https://svgo.dev/
*/
svgoConfig?: Config;
/**
* 默认导入类型
* @default url
*/
defaultImport?: 'url' | 'component' | 'skipSvgo' | 'svgo';
}
// 正则匹配,匹配以.svg为后缀名,可以包含如?raw等为命名
const svgRegex = /\.svg(\?(url|raw|component|(!svgo)))?$/;
const debug = _debug('vite-plugin-svg-import');
/**
* 定义插件
* @param options
*/
export function svgImport(options: ISvgImport = {}): Plugin {
// 默认配置
const opts: ISvgImport = {
useSvgo: false,
defaultImport: 'url',
...options
};
// 解构配置参数
const { useSvgo, svgoConfig, defaultImport } = opts;
return {
// 插件名称
name: 'vite-plugin-svg-import',
// 需要在vite核心插件之前调用
enforce: 'pre',
// id 表示导入模块的路径
load: async id => {
// 匹配路径,没有匹配到,提前返回
if (!id.match(svgRegex)) {
return;
}
// 提取前缀路径和可选条件
const [path, query] = id.split('?', 2);
// 导入类型
const importType = query || defaultImport;
// 如果是以URL的形式导入
if (importType === 'url') {
return;
}
let svg;
try {
// 使用node fs读取该路径源文件内容
svg = await fs.readFile(path, 'utf-8');
} catch (error) {
debug('\n', `${id} loaded error: ${error}`);
return;
}
// 如果是原始数据,直接以默认的方式导出
if (importType === 'raw') {
return `export default ${JSON.stringify(svg)}`;
}
// 导入类型是svgo 会覆盖全局配置useSvgo
// 或者没有配置!svgo,使用useSvgo配置,!!useSvgo && importType !== '!svgo' 相当于就是useSvgo=true,xxx.svg?component
if (importType === 'svgo' || (!!useSvgo && importType !== 'skipSvgo')) {
// 使用svgo处理svg
svg = svgOptimize(svg, {
...svgoConfig,
path
}).data;
}
// 使用vue/compiler-sfc模块中compileTemplate,把单文件组件编译成为js代码
const { code } = compileTemplate({
// 模块的路径
id: JSON.stringify(id),
// 该模块的源代码
source: svg,
// 文件名,如xxx.vue,这里是xxx.svg
filename: path,
// 配置是否需要转换为assets url导入的标记属性,这里不需要,所以false即可
transformAssetUrls: false
});
// 需要一个默认导出,否则会报错没有默认导出
return `${code}\nexport default { render: render }`;
}
};
}