vite-plugin-svg-spritegen 2.0.7 → 2.0.9

package/README.md

@@ -36,6 +36,8 @@ export default {
 };
 ```
 
+Relative paths (`baseDir`, `outputDir`) are resolved against Vite's `root`. The output directory is created if it doesn't exist.
+
 ### Generated Files
 
 The plugin writes two files to `outputDir`:

package/dist/build-svg-map.d.ts

@@ -1,2 +1,7 @@
 import type { InputConfigWithDefaults, SvgMap } from './types';
-export declare const buildSvgMap: (inputConfigs: InputConfigWithDefaults[]) => Promise<SvgMap>;
+/**
+ * Every input SVG by symbol id. `spritePath` is left out: when an input's `baseDir` is also the output directory, the
+ * generated sprite matches the input pattern too, and would otherwise turn up as an icon (in the types as well as the
+ * sprite) whenever it already exists from an earlier run.
+ */
+export declare const buildSvgMap: (inputConfigs: InputConfigWithDefaults[], spritePath?: string) => Promise<SvgMap>;

package/dist/index.js

@@ -24,23 +24,30 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 	enumerable: true
 }) : target, mod));
 //#endregion
+let node_fs = require("node:fs");
 let node_path = require("node:path");
 node_path = __toESM(node_path);
 let chokidar = require("chokidar");
 let vite = require("vite");
-let node_fs = require("node:fs");
 let fast_glob = require("fast-glob");
 fast_glob = __toESM(fast_glob);
 let node_html_parser = require("node-html-parser");
 let svgo = require("svgo");
 //#region src/build-svg-map.ts
-var buildSvgMap = async (inputConfigs) => {
+/**
+* Every input SVG by symbol id. `spritePath` is left out: when an input's `baseDir` is also the output directory, the
+* generated sprite matches the input pattern too, and would otherwise turn up as an icon (in the types as well as the
+* sprite) whenever it already exists from an earlier run.
+*/
+var buildSvgMap = async (inputConfigs, spritePath) => {
 	const svgMap = /* @__PURE__ */ new Map();
+	const excluded = spritePath && node_path.default.resolve(spritePath);
 	await Promise.all(inputConfigs.map(async (inputConfig) => {
 		const { pattern, baseDir, getSymbolId } = inputConfig;
 		const matchedPaths = await (0, fast_glob.default)(pattern, { cwd: baseDir });
 		await Promise.all(matchedPaths.map(async (matchPath) => {
 			const filePath = node_path.default.join(baseDir, matchPath);
+			if (node_path.default.resolve(filePath) === excluded) return;
 			const content = await node_fs.promises.readFile(filePath, "utf8");
 			const resolvedInputConfig = {
 				...inputConfig,
@@ -125,12 +132,11 @@ var writeGitignore = async (filePath, spriteName) => {
 };
 //#endregion
 //#region src/write-sprite.ts
-var buildSpriteContent = (svgMap, spritePath) => {
+var buildSpriteContent = (svgMap) => {
 	const symbols = [];
 	const definitions = [];
 	const svgSorted = [...svgMap].sort((a, b) => String(a[0]).localeCompare(b[0])).map(([_, svg]) => svg);
 	for (const svg of svgSorted) {
-		if (spritePath && spritePath === svg.filePath) continue;
 		let content = svg.content;
 		if (svg.svgo !== false) {
 			const svgoDefault = { plugins: [
@@ -181,7 +187,7 @@ var buildSpriteContent = (svgMap, spritePath) => {
 	return lines.join("\n");
 };
 var writeSprite = (spritePath, svgMap) => {
-	const content = buildSpriteContent(svgMap, spritePath);
+	const content = buildSpriteContent(svgMap);
 	writeIfChanged(spritePath, content);
 	return content;
 };
@@ -218,22 +224,27 @@ var SPRITE_VIRTUAL_ID = "\0virtual:svg-spritegen-sprite";
 var SPRITE_URL_PLACEHOLDER = "__SVG_SPRITEGEN_SPRITE_URL_PLACEHOLDER__";
 var toFilterArray = (p) => [p].flat().filter((x) => x != null);
 function svgSpritegen(config) {
-	const inputConfigsResolved = (Array.isArray(config.input) ? config.input : [config.input ?? inputConfigDefaults]).map((inputConfig) => {
-		const baseDir = node_path.default.resolve(process.cwd(), inputConfig.baseDir ?? inputConfigDefaults.baseDir);
-		return {
-			...inputConfigDefaults,
-			...inputConfig,
-			baseDir
-		};
-	});
+	const inputConfigs = Array.isArray(config.input) ? config.input : [config.input ?? inputConfigDefaults];
+	const resolveInputs = (root) => inputConfigs.map((inputConfig) => ({
+		...inputConfigDefaults,
+		...inputConfig,
+		baseDir: node_path.default.resolve(root, inputConfig.baseDir ?? inputConfigDefaults.baseDir)
+	}));
+	let inputConfigsResolved = resolveInputs(process.cwd());
 	const stripUnusedResolved = { ...stripUnusedDefaults };
 	if (typeof config.stripUnused === "object") Object.assign(stripUnusedResolved, config.stripUnused);
 	else if (config.stripUnused === false) stripUnusedResolved.enabled = false;
-	const outputPath = node_path.default.resolve(process.cwd(), config.outputDir);
 	const spriteNameResolved = config.spriteFileName ?? "sprite.svg";
-	const typesFilePath = (0, vite.normalizePath)(node_path.default.join(outputPath, config.typesFileName ?? "types.ts"));
-	const spriteFilePath = (0, vite.normalizePath)(node_path.default.join(outputPath, spriteNameResolved));
-	const gitignoreFilePath = (0, vite.normalizePath)(node_path.default.join(outputPath, ".gitignore"));
+	const resolveOutput = (root) => {
+		const outputPath = node_path.default.resolve(root, config.outputDir);
+		return {
+			outputPath,
+			typesFilePath: (0, vite.normalizePath)(node_path.default.join(outputPath, config.typesFileName ?? "types.ts")),
+			spriteFilePath: (0, vite.normalizePath)(node_path.default.join(outputPath, spriteNameResolved)),
+			gitignoreFilePath: (0, vite.normalizePath)(node_path.default.join(outputPath, ".gitignore"))
+		};
+	};
+	let { outputPath, typesFilePath, spriteFilePath, gitignoreFilePath } = resolveOutput(process.cwd());
 	const matchPatternRe = new RegExp(stripUnusedResolved.matchPattern, "g");
 	const idIncludes = toFilterArray(stripUnusedResolved.srcInclude);
 	const idExcludes = ["**/node_modules/**", ...toFilterArray(stripUnusedResolved.srcExclude)];
@@ -246,12 +257,15 @@ function svgSpritegen(config) {
 	return {
 		name: "svg-spritegen",
 		enforce: "pre",
-		configResolved(config) {
-			isBuild = config.command === "build";
-			viteBase = config.base ?? "/";
+		configResolved(viteConfig) {
+			isBuild = viteConfig.command === "build";
+			viteBase = viteConfig.base ?? "/";
+			inputConfigsResolved = resolveInputs(viteConfig.root);
+			({outputPath, typesFilePath, spriteFilePath, gitignoreFilePath} = resolveOutput(viteConfig.root));
 		},
 		async buildStart() {
-			allSvgs = await buildSvgMap(inputConfigsResolved);
+			(0, node_fs.mkdirSync)(outputPath, { recursive: true });
+			allSvgs = await buildSvgMap(inputConfigsResolved, spriteFilePath);
 			await writeTypes(typesFilePath, allSvgs);
 			if (config.gitignore !== false) await writeGitignore(gitignoreFilePath, spriteNameResolved);
 			if (isBuild) {
@@ -261,7 +275,7 @@ function svgSpritegen(config) {
 			writeSprite(spriteFilePath, allSvgs);
 			const onWatch = (changedPath) => {
 				if (changedPath === spriteFilePath) return;
-				buildSvgMap(inputConfigsResolved).then((newAllSvgFiles) => {
+				buildSvgMap(inputConfigsResolved, spriteFilePath).then((newAllSvgFiles) => {
 					writeSprite(spriteFilePath, newAllSvgFiles);
 				});
 			};
@@ -311,7 +325,7 @@ function svgSpritegen(config) {
 			spriteRefId = this.emitFile({
 				type: "asset",
 				name: spriteNameResolved,
-				source: buildSpriteContent(sourceMap, spriteFilePath)
+				source: buildSpriteContent(sourceMap)
 			});
 		},
 		renderChunk: {

package/dist/index.mjs

@@ -1,18 +1,25 @@
+import { mkdirSync, promises, readFileSync, writeFileSync } from "node:fs";
 import path from "node:path";
 import { watch } from "chokidar";
 import { normalizePath } from "vite";
-import { promises, readFileSync, writeFileSync } from "node:fs";
 import fastGlob from "fast-glob";
 import { parse } from "node-html-parser";
 import { optimize } from "svgo";
 //#region src/build-svg-map.ts
-var buildSvgMap = async (inputConfigs) => {
+/**
+* Every input SVG by symbol id. `spritePath` is left out: when an input's `baseDir` is also the output directory, the
+* generated sprite matches the input pattern too, and would otherwise turn up as an icon (in the types as well as the
+* sprite) whenever it already exists from an earlier run.
+*/
+var buildSvgMap = async (inputConfigs, spritePath) => {
 	const svgMap = /* @__PURE__ */ new Map();
+	const excluded = spritePath && path.resolve(spritePath);
 	await Promise.all(inputConfigs.map(async (inputConfig) => {
 		const { pattern, baseDir, getSymbolId } = inputConfig;
 		const matchedPaths = await fastGlob(pattern, { cwd: baseDir });
 		await Promise.all(matchedPaths.map(async (matchPath) => {
 			const filePath = path.join(baseDir, matchPath);
+			if (path.resolve(filePath) === excluded) return;
 			const content = await promises.readFile(filePath, "utf8");
 			const resolvedInputConfig = {
 				...inputConfig,
@@ -97,12 +104,11 @@ var writeGitignore = async (filePath, spriteName) => {
 };
 //#endregion
 //#region src/write-sprite.ts
-var buildSpriteContent = (svgMap, spritePath) => {
+var buildSpriteContent = (svgMap) => {
 	const symbols = [];
 	const definitions = [];
 	const svgSorted = [...svgMap].sort((a, b) => String(a[0]).localeCompare(b[0])).map(([_, svg]) => svg);
 	for (const svg of svgSorted) {
-		if (spritePath && spritePath === svg.filePath) continue;
 		let content = svg.content;
 		if (svg.svgo !== false) {
 			const svgoDefault = { plugins: [
@@ -153,7 +159,7 @@ var buildSpriteContent = (svgMap, spritePath) => {
 	return lines.join("\n");
 };
 var writeSprite = (spritePath, svgMap) => {
-	const content = buildSpriteContent(svgMap, spritePath);
+	const content = buildSpriteContent(svgMap);
 	writeIfChanged(spritePath, content);
 	return content;
 };
@@ -190,22 +196,27 @@ var SPRITE_VIRTUAL_ID = "\0virtual:svg-spritegen-sprite";
 var SPRITE_URL_PLACEHOLDER = "__SVG_SPRITEGEN_SPRITE_URL_PLACEHOLDER__";
 var toFilterArray = (p) => [p].flat().filter((x) => x != null);
 function svgSpritegen(config) {
-	const inputConfigsResolved = (Array.isArray(config.input) ? config.input : [config.input ?? inputConfigDefaults]).map((inputConfig) => {
-		const baseDir = path.resolve(process.cwd(), inputConfig.baseDir ?? inputConfigDefaults.baseDir);
-		return {
-			...inputConfigDefaults,
-			...inputConfig,
-			baseDir
-		};
-	});
+	const inputConfigs = Array.isArray(config.input) ? config.input : [config.input ?? inputConfigDefaults];
+	const resolveInputs = (root) => inputConfigs.map((inputConfig) => ({
+		...inputConfigDefaults,
+		...inputConfig,
+		baseDir: path.resolve(root, inputConfig.baseDir ?? inputConfigDefaults.baseDir)
+	}));
+	let inputConfigsResolved = resolveInputs(process.cwd());
 	const stripUnusedResolved = { ...stripUnusedDefaults };
 	if (typeof config.stripUnused === "object") Object.assign(stripUnusedResolved, config.stripUnused);
 	else if (config.stripUnused === false) stripUnusedResolved.enabled = false;
-	const outputPath = path.resolve(process.cwd(), config.outputDir);
 	const spriteNameResolved = config.spriteFileName ?? "sprite.svg";
-	const typesFilePath = normalizePath(path.join(outputPath, config.typesFileName ?? "types.ts"));
-	const spriteFilePath = normalizePath(path.join(outputPath, spriteNameResolved));
-	const gitignoreFilePath = normalizePath(path.join(outputPath, ".gitignore"));
+	const resolveOutput = (root) => {
+		const outputPath = path.resolve(root, config.outputDir);
+		return {
+			outputPath,
+			typesFilePath: normalizePath(path.join(outputPath, config.typesFileName ?? "types.ts")),
+			spriteFilePath: normalizePath(path.join(outputPath, spriteNameResolved)),
+			gitignoreFilePath: normalizePath(path.join(outputPath, ".gitignore"))
+		};
+	};
+	let { outputPath, typesFilePath, spriteFilePath, gitignoreFilePath } = resolveOutput(process.cwd());
 	const matchPatternRe = new RegExp(stripUnusedResolved.matchPattern, "g");
 	const idIncludes = toFilterArray(stripUnusedResolved.srcInclude);
 	const idExcludes = ["**/node_modules/**", ...toFilterArray(stripUnusedResolved.srcExclude)];
@@ -218,12 +229,15 @@ function svgSpritegen(config) {
 	return {
 		name: "svg-spritegen",
 		enforce: "pre",
-		configResolved(config) {
-			isBuild = config.command === "build";
-			viteBase = config.base ?? "/";
+		configResolved(viteConfig) {
+			isBuild = viteConfig.command === "build";
+			viteBase = viteConfig.base ?? "/";
+			inputConfigsResolved = resolveInputs(viteConfig.root);
+			({outputPath, typesFilePath, spriteFilePath, gitignoreFilePath} = resolveOutput(viteConfig.root));
 		},
 		async buildStart() {
-			allSvgs = await buildSvgMap(inputConfigsResolved);
+			mkdirSync(outputPath, { recursive: true });
+			allSvgs = await buildSvgMap(inputConfigsResolved, spriteFilePath);
 			await writeTypes(typesFilePath, allSvgs);
 			if (config.gitignore !== false) await writeGitignore(gitignoreFilePath, spriteNameResolved);
 			if (isBuild) {
@@ -233,7 +247,7 @@ function svgSpritegen(config) {
 			writeSprite(spriteFilePath, allSvgs);
 			const onWatch = (changedPath) => {
 				if (changedPath === spriteFilePath) return;
-				buildSvgMap(inputConfigsResolved).then((newAllSvgFiles) => {
+				buildSvgMap(inputConfigsResolved, spriteFilePath).then((newAllSvgFiles) => {
 					writeSprite(spriteFilePath, newAllSvgFiles);
 				});
 			};
@@ -283,7 +297,7 @@ function svgSpritegen(config) {
 			spriteRefId = this.emitFile({
 				type: "asset",
 				name: spriteNameResolved,
-				source: buildSpriteContent(sourceMap, spriteFilePath)
+				source: buildSpriteContent(sourceMap)
 			});
 		},
 		renderChunk: {

package/dist/write-sprite.d.ts

@@ -1,3 +1,3 @@
 import type { SvgMap } from './types';
-export declare const buildSpriteContent: (svgMap: SvgMap, spritePath?: string) => string;
+export declare const buildSpriteContent: (svgMap: SvgMap) => string;
 export declare const writeSprite: (spritePath: string, svgMap: SvgMap) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-svg-spritegen",
-  "version": "2.0.7",
+  "version": "2.0.9",
   "description": "Vite plugin that generates an svg spritesheet, optionally removing unused svg files.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",