vite-plugin-svg4vue/lib/index.esm.js

A vite plugin which can transform svg icon to vue component, support optimization via SVGO, easy to customize svg color and size.

import { compileTemplate } from 'vue/compiler-sfc';
import * as SVGO from 'svgo';
import { createDefu } from 'defu';
import { hash } from 'ohash';
import { readFileSync } from 'node:fs';
import { createSvgoConfig } from 'svgo-extra';
import qs from 'node:querystring';
import * as ufo from 'ufo';

async function compileSvg(source, id) {
    source = source
        .replace(/<style/g, '<component is="style"')
        .replace(/<\/style/g, '</component');
    const { code: renderFunctionCode, map } = compileTemplate({
        id,
        filename: id,
        source,
        transformAssetUrls: false,
    });
    const code = `${renderFunctionCode}\nexport default { render };`;
    return {
        code,
        map,
    };
}

const withDefaultConfig = (source, defaults) => {
    const def = createDefu((obj, key, value) => {
        if (Array.isArray(value) && Array.isArray(obj[key])) {
            obj[key] = [...obj[key], ...value];
            return true;
        }
    });
    return def(source, defaults);
};

const defaultSvgoConfig = (incommingConfig, opts, id) => {
    const hashedPrefix = `${opts?.namespacePrefix || 'a'}${hash({ id }).slice(0, 6)}`;
    const inconfig = typeof incommingConfig === 'boolean'
        ? {}
        : incommingConfig
            ? incommingConfig
            : {};
    const deConfig = {
        plugins: [
            {
                name: 'prefixIds',
                params: {
                    prefix: () => hashedPrefix,
                    prefixIds: opts?.namespaceIDs,
                    prefixClassNames: opts?.namespaceClassnames,
                },
            },
        ],
    };
    const outputConfig = withDefaultConfig(inconfig, deConfig);
    return outputConfig;
};
async function optimizeSvg(content, path, finalSvgoConfig = {}) {
    const { data } = await SVGO.optimize(content, {
        ...finalSvgoConfig,
        path,
    });
    return data;
}

function compileSvgToRaw(source) {
    const formatSource = JSON.stringify(source);
    const code = `\nexport default ${formatSource};`;
    return code;
}

const COMPONENT_COMPILE_TYPE = 'component';
const RAW_COMPILE_TYPE = 'raw';
const URL_COMPILE_TYPE = 'url';
const SKIP_SVGO_FLAG = 'skipsvgo';
const SKIP_MONOCHROME = 'skip-monochrome';
const SKIP_RESPONSIVE = 'skip-responsive';
var DEFAULT_OPTIONS;
(function (DEFAULT_OPTIONS) {
    DEFAULT_OPTIONS["defaultExport"] = "url";
    DEFAULT_OPTIONS["assetsDirName"] = "icons";
})(DEFAULT_OPTIONS || (DEFAULT_OPTIONS = {}));

const resolveSearchParams = (url, assetsDirName) => {
    const idWithoutQuery = url.replace(/\.svg\?.*/, '.svg');
    const assetsDirNameString = assetsDirName === false
        ? ''
        : assetsDirName === true
            ? DEFAULT_OPTIONS.assetsDirName
            : assetsDirName;
    const safeAssetsDirName = assetsDirNameString
        ? ufo.withTrailingSlash(assetsDirNameString)
        : '';
    const svgRegexString = `${safeAssetsDirName}.*\\.svg(\\?.*)?$`;
    const svgRegex = new RegExp(svgRegexString);
    const matchedId = url.match(svgRegex);
    const querystring = Array.isArray(matchedId) && matchedId[1]
        ? matchedId[1].replace('?', '')
        : '';
    const searchParamsKeys = Object.keys(qs.parse(querystring));
    const skipsvgo = searchParamsKeys.includes(SKIP_SVGO_FLAG);
    const skipMonochrome = searchParamsKeys.includes(SKIP_MONOCHROME);
    const skipResposive = searchParamsKeys.includes(SKIP_RESPONSIVE);
    let type = undefined;
    if (searchParamsKeys.includes(COMPONENT_COMPILE_TYPE)) {
        type = COMPONENT_COMPILE_TYPE;
    }
    else if (searchParamsKeys.includes(RAW_COMPILE_TYPE)) {
        type = RAW_COMPILE_TYPE;
    }
    else if (searchParamsKeys.includes(URL_COMPILE_TYPE)) {
        type = URL_COMPILE_TYPE;
    }
    return {
        type,
        skipsvgo,
        skipMonochrome,
        skipResposive,
        searchParamsKeys,
        matchedId,
        idWithoutQuery,
        querystring,
    };
};

const svg4VuePlugin = (options = {}) => {
    const { svgoConfig = {}, defaultExport = DEFAULT_OPTIONS.defaultExport, assetsDirName = DEFAULT_OPTIONS.assetsDirName, enableBuildCache = true, enableMonochromeSvgOptimize = true, enableSvgSizeResponsive = true, enableSvgoPresetDefaultConfig = true, namespaceClassnames = true, namespaceIDs = true, namespacePrefix = 'a', enforce = 'pre', } = options;
    const svgComponentCache = new Map();
    const svgRawCache = new Map();
    let isBuild = false;
    const disabledSvgo = svgoConfig === false;
    const finalEnforce = typeof enforce === 'string' ? enforce : enforce === true ? 'pre' : undefined;
    return {
        name: 'vite-plugin-svg4vue',
        enforce: finalEnforce,
        configResolved(config) {
            isBuild = config.mode === 'production';
        },
        async transform(source, id) {
            const { idWithoutQuery, type, matchedId, skipsvgo, skipMonochrome, skipResposive, } = resolveSearchParams(id, assetsDirName);
            const finalSvgoConfig = createSvgoConfig(defaultSvgoConfig(svgoConfig, {
                namespaceClassnames,
                namespaceIDs,
                namespacePrefix,
            }, idWithoutQuery), {
                moveStrokeAttrToSvgNode: enableMonochromeSvgOptimize && !skipMonochrome,
                movePathFillAttrToSvgNode: enableMonochromeSvgOptimize && !skipMonochrome,
                responsiveSVGSize: enableSvgSizeResponsive && !skipResposive,
                presetDefault: enableSvgoPresetDefaultConfig,
            });
            if (matchedId) {
                if ((defaultExport === RAW_COMPILE_TYPE && typeof type === 'undefined') ||
                    type === RAW_COMPILE_TYPE) {
                    if (disabledSvgo || skipsvgo)
                        return source;
                    let cachedSvgRawResult = svgRawCache.get(id);
                    if (!cachedSvgRawResult) {
                        const code = readFileSync(idWithoutQuery, 'utf8');
                        const svg = await optimizeSvg(code, idWithoutQuery, finalSvgoConfig);
                        cachedSvgRawResult = compileSvgToRaw(svg);
                        if (enableBuildCache && isBuild) {
                            svgRawCache.set(id, cachedSvgRawResult);
                        }
                    }
                    return cachedSvgRawResult;
                }
                if ((defaultExport === URL_COMPILE_TYPE && typeof type === 'undefined') ||
                    type === URL_COMPILE_TYPE) {
                    return source;
                }
                if ((defaultExport === COMPONENT_COMPILE_TYPE &&
                    typeof type === 'undefined') ||
                    type === COMPONENT_COMPILE_TYPE) {
                    let cachedSvgComponentResult = svgComponentCache.get(id);
                    if (!cachedSvgComponentResult) {
                        const code = readFileSync(idWithoutQuery, 'utf8');
                        let svg = code;
                        if (!disabledSvgo && !skipsvgo) {
                            svg = await optimizeSvg(code, idWithoutQuery, finalSvgoConfig);
                        }
                        cachedSvgComponentResult = await compileSvg(svg, idWithoutQuery);
                        if (enableBuildCache && isBuild) {
                            svgComponentCache.set(id, cachedSvgComponentResult);
                        }
                    }
                    return cachedSvgComponentResult;
                }
            }
        },
    };
};

export { svg4VuePlugin };