vite-plugin-svg-spritegen 2.0.1 → 2.0.3

package/README.md

@@ -36,6 +36,15 @@ export default {
 };
 ```
 
+### Generated Files
+
+The plugin writes two files to `outputDir`:
+
+- `sprite.svg` — the generated spritesheet. This is a build artifact, so the plugin adds it to a `.gitignore` inside `outputDir` (disable this with `gitignore: false`).
+- `types.ts` — the `IconName` type and `iconNames` array, always generated from the **full** set of source SVGs (`stripUnused` never affects it). **Commit this file** so typechecking works on a fresh clone without running a build first. It regenerates automatically on every dev-server start and build, so it can't drift for long.
+
+> **Upgrading from v2.0.1 or earlier?** Previous versions added `types.ts` to the generated `.gitignore`. The plugin removes that stale entry the next time it runs — after that, `git add` your `types.ts` to start tracking it.
+
 ### Example Icon Component
 
 ```jsx

package/dist/index.js

@@ -82,31 +82,44 @@ var writeTypes = async (filePath, svgMap) => {
 	await writeIfChanged(filePath, [
 		"/* eslint-disable */",
 		"",
-		"// This file is autogenerated. Do not commit to source control.",
+		"// This file is autogenerated. Keep it committed so typechecking works without a build.",
 		"",
 		"export type IconName = (typeof iconNames)[number];",
 		"",
 		"export const iconNames = [",
-		...[...svgMap.keys()].map((name) => `  '${name}',`),
+		...[...svgMap.keys()].sort().map((name) => `  '${name}',`),
 		"] as const;",
 		""
 	].join("\n"));
 };
 //#endregion
 //#region src/write-gitignore.ts
-var writeGitignore = async (filePath, spriteName, typesName) => {
-	const content = [
-		"# svg spritegen",
-		spriteName,
-		typesName
-	].join("\n");
+var SECTION_HEADER = "# svg spritegen";
+var writeGitignore = async (filePath, spriteName) => {
+	const section = [SECTION_HEADER, spriteName].join("\n");
+	let currentContent;
 	try {
-		const currentContent = await node_fs.promises.readFile(filePath, "utf8");
-		if (currentContent.includes(content)) return;
-		else await node_fs.promises.writeFile(filePath, currentContent + "\n" + content, "utf8");
+		currentContent = await node_fs.promises.readFile(filePath, "utf8");
 	} catch (e) {
-		await node_fs.promises.writeFile(filePath, content, "utf8");
+		await node_fs.promises.writeFile(filePath, section + "\n", "utf8");
+		return;
 	}
+	const kept = [];
+	let inSection = false;
+	for (const line of currentContent.split("\n")) {
+		if (line.trim() === SECTION_HEADER) {
+			inSection = true;
+			continue;
+		}
+		if (inSection) {
+			if (line.trim() !== "" && !line.startsWith("#")) continue;
+			inSection = false;
+		}
+		kept.push(line);
+	}
+	const preserved = kept.join("\n").trim();
+	const newContent = (preserved ? preserved + "\n\n" : "") + section + "\n";
+	if (newContent !== currentContent) await node_fs.promises.writeFile(filePath, newContent, "utf8");
 };
 //#endregion
 //#region src/write-sprite.ts
@@ -227,8 +240,11 @@ function svgSpritegen(config) {
 		async buildStart() {
 			allSvgs = await buildSvgMap(inputConfigsResolved);
 			await writeTypes(typesFilePath, allSvgs);
-			if (config.gitignore !== false) await writeGitignore(gitignoreFilePath, "sprite.svg", "types.ts");
-			if (isBuild) return;
+			if (config.gitignore !== false) await writeGitignore(gitignoreFilePath, spriteNameResolved);
+			if (isBuild) {
+				writeIfChanged(spriteFilePath);
+				return;
+			}
 			writeSprite(spriteFilePath, allSvgs);
 			const onWatch = (changedPath) => {
 				if (changedPath === spriteFilePath) return;

package/dist/index.mjs

@@ -54,31 +54,44 @@ var writeTypes = async (filePath, svgMap) => {
 	await writeIfChanged(filePath, [
 		"/* eslint-disable */",
 		"",
-		"// This file is autogenerated. Do not commit to source control.",
+		"// This file is autogenerated. Keep it committed so typechecking works without a build.",
 		"",
 		"export type IconName = (typeof iconNames)[number];",
 		"",
 		"export const iconNames = [",
-		...[...svgMap.keys()].map((name) => `  '${name}',`),
+		...[...svgMap.keys()].sort().map((name) => `  '${name}',`),
 		"] as const;",
 		""
 	].join("\n"));
 };
 //#endregion
 //#region src/write-gitignore.ts
-var writeGitignore = async (filePath, spriteName, typesName) => {
-	const content = [
-		"# svg spritegen",
-		spriteName,
-		typesName
-	].join("\n");
+var SECTION_HEADER = "# svg spritegen";
+var writeGitignore = async (filePath, spriteName) => {
+	const section = [SECTION_HEADER, spriteName].join("\n");
+	let currentContent;
 	try {
-		const currentContent = await promises.readFile(filePath, "utf8");
-		if (currentContent.includes(content)) return;
-		else await promises.writeFile(filePath, currentContent + "\n" + content, "utf8");
+		currentContent = await promises.readFile(filePath, "utf8");
 	} catch (e) {
-		await promises.writeFile(filePath, content, "utf8");
+		await promises.writeFile(filePath, section + "\n", "utf8");
+		return;
 	}
+	const kept = [];
+	let inSection = false;
+	for (const line of currentContent.split("\n")) {
+		if (line.trim() === SECTION_HEADER) {
+			inSection = true;
+			continue;
+		}
+		if (inSection) {
+			if (line.trim() !== "" && !line.startsWith("#")) continue;
+			inSection = false;
+		}
+		kept.push(line);
+	}
+	const preserved = kept.join("\n").trim();
+	const newContent = (preserved ? preserved + "\n\n" : "") + section + "\n";
+	if (newContent !== currentContent) await promises.writeFile(filePath, newContent, "utf8");
 };
 //#endregion
 //#region src/write-sprite.ts
@@ -199,8 +212,11 @@ function svgSpritegen(config) {
 		async buildStart() {
 			allSvgs = await buildSvgMap(inputConfigsResolved);
 			await writeTypes(typesFilePath, allSvgs);
-			if (config.gitignore !== false) await writeGitignore(gitignoreFilePath, "sprite.svg", "types.ts");
-			if (isBuild) return;
+			if (config.gitignore !== false) await writeGitignore(gitignoreFilePath, spriteNameResolved);
+			if (isBuild) {
+				writeIfChanged(spriteFilePath);
+				return;
+			}
 			writeSprite(spriteFilePath, allSvgs);
 			const onWatch = (changedPath) => {
 				if (changedPath === spriteFilePath) return;

package/dist/write-gitignore.d.ts

@@ -1 +1 @@
-export declare const writeGitignore: (filePath: string, spriteName: string, typesName: string) => Promise<void>;
+export declare const writeGitignore: (filePath: string, spriteName: string) => Promise<void>;

package/package.json

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