vite-plugin-svg-spritegen 2.0.3 → 2.0.5

package/README.md

@@ -66,3 +66,34 @@ export const IconBase: FC<SVGProps<SVGSVGElement> & { icon: IconName }> = ({ ico
 ```jsx
 <Icon icon="plus" />
 ```
+
+### Stripping Unused Icons
+
+By default the plugin scans your source files during `build` and drops any icons that
+aren't referenced, keeping the emitted `sprite.svg` small. Configure this via `stripUnused`:
+
+```typescript
+svgSpritegen({
+  outputDir: 'src/assets/icons',
+  stripUnused: {
+    // Set false to include every source SVG in the sprite.
+    enabled: true,
+    // A RegExp (or string) with a named capture group `icon`. Every match is checked
+    // against the real icon set, so unrelated strings are ignored automatically.
+    matchPattern: /['"`](?<icon>[^'"`\r\n]+?)['"`]/g,
+    // Which files to scan / skip (node_modules is always excluded).
+    srcInclude: ['**/*.[jt]sx', '**/*.md?(x)'],
+    srcExclude: [],
+    // Icon ids to always keep, even if they aren't detected in source.
+    whitelist: [],
+  },
+});
+```
+
+The default `matchPattern` treats **any quoted string** (`"star"`, `'star'`, or
+`` `star` ``) as a possible icon reference. Because each candidate is validated against the
+generated icon set before being kept, over-matching is harmless — this catches icon names
+wherever they appear (component props, object/record values, ternaries, arrays) rather than
+only `icon="..."` assignments. Provide your own `matchPattern` (with an `icon` named group)
+to narrow this if needed, and use `whitelist` for icons chosen in ways static analysis can't
+see (e.g. names built from runtime data).

package/dist/index.js

@@ -81,13 +81,15 @@ var writeIfChanged = (filePath, content) => {
 var writeTypes = async (filePath, svgMap) => {
 	await writeIfChanged(filePath, [
 		"/* eslint-disable */",
+		"// biome-ignore-all format: autogenerated file — kept byte-stable across rebuilds",
+		"// biome-ignore-all lint: autogenerated file — kept byte-stable across rebuilds",
 		"",
 		"// This file is autogenerated. Keep it committed so typechecking works without a build.",
 		"",
 		"export type IconName = (typeof iconNames)[number];",
 		"",
 		"export const iconNames = [",
-		...[...svgMap.keys()].sort().map((name) => `  '${name}',`),
+		...[...svgMap.keys()].sort().map((name) => `\t'${name}',`),
 		"] as const;",
 		""
 	].join("\n"));
@@ -185,7 +187,7 @@ var writeSprite = (spritePath, svgMap) => {
 };
 //#endregion
 //#region src/index.ts
-var defaultMatchPattern = /['"`]?icon['"`]?\s*[=:]{1}\s*['"`]{1}(?<icon>.+?)['"`]{1}/gi;
+var defaultMatchPattern = /['"`](?<icon>[^'"`\r\n]+?)['"`]/g;
 var inputConfigDefaults = {
 	pattern: "**/*.svg",
 	baseDir: "./",

package/dist/index.mjs

@@ -53,13 +53,15 @@ var writeIfChanged = (filePath, content) => {
 var writeTypes = async (filePath, svgMap) => {
 	await writeIfChanged(filePath, [
 		"/* eslint-disable */",
+		"// biome-ignore-all format: autogenerated file — kept byte-stable across rebuilds",
+		"// biome-ignore-all lint: autogenerated file — kept byte-stable across rebuilds",
 		"",
 		"// This file is autogenerated. Keep it committed so typechecking works without a build.",
 		"",
 		"export type IconName = (typeof iconNames)[number];",
 		"",
 		"export const iconNames = [",
-		...[...svgMap.keys()].sort().map((name) => `  '${name}',`),
+		...[...svgMap.keys()].sort().map((name) => `\t'${name}',`),
 		"] as const;",
 		""
 	].join("\n"));
@@ -157,7 +159,7 @@ var writeSprite = (spritePath, svgMap) => {
 };
 //#endregion
 //#region src/index.ts
-var defaultMatchPattern = /['"`]?icon['"`]?\s*[=:]{1}\s*['"`]{1}(?<icon>.+?)['"`]{1}/gi;
+var defaultMatchPattern = /['"`](?<icon>[^'"`\r\n]+?)['"`]/g;
 var inputConfigDefaults = {
 	pattern: "**/*.svg",
 	baseDir: "./",

package/package.json

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