svg-icon-baker 1.1.3 → 1.2.1

package/LICENSE

@@ -1,7 +1,3 @@
-# svg-icon-baker license
-
-svg-icon-baker is released under the MIT license:
-
 MIT License
 
 Copyright (c) 2025-present, yangxu52
@@ -23,38 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-
-# Licenses of bundled dependencies
-
-The published svg-icon-baker artifact additionally contains code with the following licenses:
-MIT
-
-# Bundled dependencies:
-
-## fast-glob
-
-License: MIT
-by: Kir Belevich
-Repository: https://github.com/svg/svgo
-
-> MIT License
->
-> Copyright (c) Kir Belevich
->
-> Permission is hereby granted, free of charge, to any person obtaining a copy
-> of this software and associated documentation files (the "Software"), to deal
-> in the Software without restriction, including without limitation the rights
-> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-> copies of the Software, and to permit persons to whom the Software is
-> furnished to do so, subject to the following conditions:
->
-> The above copyright notice and this permission notice shall be included in all
-> copies or substantial portions of the Software.
->
-> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-> SOFTWARE.

package/README.md

@@ -32,27 +32,25 @@ Convert multiple SVG inputs with one inferred option set.
 
 ## Options
 
-| name                      | type      | default | description                                        |
-| ------------------------- | --------- | ------- | -------------------------------------------------- |
-| `defaultPreset`           | `boolean` | `true`  | Enable SVGO `preset-default`.                      |
-| `convertOneStopGradients` | `boolean` | `false` | Convert one-stop gradients.                        |
-| `convertStyleToAttrs`     | `boolean` | `false` | Convert style blocks to attributes.                |
-| `reusePaths`              | `boolean` | `false` | Try to reuse identical paths.                      |
-| `removeScripts`           | `boolean` | `false` | Drop `<script>` for safety.                        |
-| `removeTitle`             | `boolean` | `true`  | Remove `<title>` elements from symbols.            |
-| `removeXMLNS`             | `boolean` | `true`  | Remove xmlns on root when emitting sprite content. |
-| `removeXlink`             | `boolean` | `true`  | Remove xlink namespace and prefer `href`.          |
+| name          | type          | default | description                                      |
+| ------------- | ------------- | ------- | ------------------------------------------------ |
+| `optimize`    | `boolean`     | `true`  | Enable default safe SVGO optimization preset.    |
+| `svgoOptions` | `SvgoOptions` | `{}`    | Custom SVGO options into the optimization layer. |
 
 Notes:
 
-- Set `true` to use the default optimization set.
-- Set `false` to disable optional optimizations. Mandatory conversion steps still run, including `removeDimensions`, `prefixIds`, and SVG-to-symbol rewriting.
-- The library prefixes internal ids and URL references via SVGO `prefixIds`, using the icon name as prefix, for example `home-a`.
-- Root `width` and `height` are removed. `viewBox` must already exist or be inferable from root dimensions.
+- Behavior matrix:
+  - `optimize: true` + no `svgoOptions`: run default safe optimization.
+  - `optimize: true` + `svgoOptions`: run default safe optimization, then merge custom options.
+  - `optimize: false` + no `svgoOptions`: skip optimization layer.
+  - `optimize: false` + `svgoOptions`: run custom optimization settings only.
+- When `svgoOptions.plugins` is provided, custom plugins run after default safe optimization plugins.
 
 ## Type Definitions
 
 ```ts
+import type { Config } from 'svgo'
+
 type BakeSource = {
   name: string
   content: string
@@ -63,25 +61,19 @@ type BakeResult = {
   content: string
 }
 
-type Options =
-  | {
-      defaultPreset?: boolean
-      convertOneStopGradients?: boolean
-      convertStyleToAttrs?: boolean
-      reusePaths?: boolean
-      removeScripts?: boolean
-      removeTitle?: boolean
-      removeXMLNS?: boolean
-      removeXlink?: boolean
-    }
-  | boolean
+type SvgoOptions = Pick<Config, 'multipass' | 'floatPrecision' | 'js2svg' | 'plugins'>
+
+type Options = {
+  optimize?: boolean
+  svgoOptions?: SvgoOptions
+}
 ```
 
 ## Features
 
-- 🎯 Optimization: Reduce file size, and improve efficiency through `SVGO`
-- 🔗 Reference Handling: ID and reference prefixing for sprite safety
-- 🎨 Size Unify: `viewBox` preservation or inference from root dimensions
+- Optimization: Reduce file size, and improve efficiency through `SVGO`
+- Reference Handling: ID and reference prefixing for sprite safety
+- Size Unify: `viewBox` preservation or inference from root dimensions
 
 ## License
 

package/dist/index.d.mts

@@ -1,3 +1,5 @@
+import { Config } from 'svgo';
+
 type BakeSource = {
     name: string;
     content: string;
@@ -6,52 +8,21 @@ type BakeResult = {
     name: string;
     content: string;
 };
-type ManualOptions = {
-    /**
-     * default plugin preset
-     * @default true
-     */
-    defaultPreset?: boolean;
-    /**
-     * convert one stop gradients to inline styles
-     * @default false
-     */
-    convertOneStopGradients?: boolean;
-    /**
-     * convert style to attrs
-     * @default false
-     */
-    convertStyleToAttrs?: boolean;
+type SvgoOptions = Pick<Config, 'multipass' | 'floatPrecision' | 'js2svg' | 'plugins'>;
+type Options = {
     /**
-     * reuse paths
-     * @default false
-     */
-    reusePaths?: boolean;
-    /**
-     * remove scripts
-     * @default false
-     */
-    removeScripts?: boolean;
-    /**
-     * remove title
+     * enable/disable default safe optimization preset
      * @default true
      */
-    removeTitle?: boolean;
+    optimize?: boolean;
     /**
-     * remove xmlns
-     * @default true
-     */
-    removeXMLNS?: boolean;
-    /**
-     * remove xlink
-     * @default true
+     * custom svgo options merged into optimizer
      */
-    removeXlink?: boolean;
+    svgoOptions?: SvgoOptions;
 };
-type Options = boolean | ManualOptions;
 
 declare function bakeIcon(source: BakeSource, options?: Options): BakeResult;
 declare function bakeIcons(sources: BakeSource[], options?: Options): BakeResult[];
 
 export { bakeIcon, bakeIcons };
-export type { BakeResult, BakeSource, Options };
+export type { BakeResult, BakeSource, Options, SvgoOptions };

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { Config } from 'svgo';
+
 type BakeSource = {
     name: string;
     content: string;
@@ -6,52 +8,21 @@ type BakeResult = {
     name: string;
     content: string;
 };
-type ManualOptions = {
-    /**
-     * default plugin preset
-     * @default true
-     */
-    defaultPreset?: boolean;
-    /**
-     * convert one stop gradients to inline styles
-     * @default false
-     */
-    convertOneStopGradients?: boolean;
-    /**
-     * convert style to attrs
-     * @default false
-     */
-    convertStyleToAttrs?: boolean;
+type SvgoOptions = Pick<Config, 'multipass' | 'floatPrecision' | 'js2svg' | 'plugins'>;
+type Options = {
     /**
-     * reuse paths
-     * @default false
-     */
-    reusePaths?: boolean;
-    /**
-     * remove scripts
-     * @default false
-     */
-    removeScripts?: boolean;
-    /**
-     * remove title
+     * enable/disable default safe optimization preset
      * @default true
      */
-    removeTitle?: boolean;
+    optimize?: boolean;
     /**
-     * remove xmlns
-     * @default true
-     */
-    removeXMLNS?: boolean;
-    /**
-     * remove xlink
-     * @default true
+     * custom svgo options merged into optimizer
      */
-    removeXlink?: boolean;
+    svgoOptions?: SvgoOptions;
 };
-type Options = boolean | ManualOptions;
 
 declare function bakeIcon(source: BakeSource, options?: Options): BakeResult;
 declare function bakeIcons(sources: BakeSource[], options?: Options): BakeResult[];
 
 export { bakeIcon, bakeIcons };
-export type { BakeResult, BakeSource, Options };
+export type { BakeResult, BakeSource, Options, SvgoOptions };

package/dist/index.mjs

@@ -1 +1,113 @@
-import{optimize as m}from"svgo";function c(e,r){const t=i(r),n=l(t);return{name:e.name,content:o(e,n)}}function p(e,r){const t=i(r),n=l(t);return e.map(s=>({name:s.name,content:o(s,n)}))}function o(e,r){if(!e||!e.name||!e.content)throw new TypeError("Property name and content are required.");if(!/^[A-Za-z][A-Za-z0-9_-]*$/.test(e.name))throw new TypeError("Invalid name. Use letters, numbers, dash, or underscore, starting with a letter.");r.push({name:"prefixIds",params:{prefix:`${e.name}-`,delim:""}});let t;try{t=m(e.content,{plugins:r})}catch(a){throw new Error(`Parsing failed. ${String(a)}`)}const n=t.data.match(/viewBox="([^"]+)"/)?.[1];if(!n)throw new Error("Cannot determine viewBox. Provide an SVG with viewBox or width/height attributes.");const s=t.data.replace(/^\s*<\?xml[^>]*\?>\s*/i,"");return u(s,e.name,n)}function u(e,r,t){const n=e.match(/^\s*<svg\b[^>]*>/i)[0].replace(/^\s*<svg\b/i,"").replace(/>\s*$/i,"").replace(/\s+id=(['"])[^'"]*\1/gi,"").replace(/\s+viewBox=(['"])[^'"]*\1/gi,"").replace(/\s+width=(['"])[^'"]*\1/gi,"").replace(/\s+height=(['"])[^'"]*\1/gi,"").trim(),s=n?` ${n}`:"",a=`<symbol id="${r}" viewBox="${t}"${s}>`;return e.replace(/^\s*<svg\b[^>]*>/i,a).replace(/<\/svg>\s*$/i,"</symbol>").trim()}function i(e){const r={defaultPreset:!0,convertOneStopGradients:!1,convertStyleToAttrs:!1,reusePaths:!1,removeScripts:!1,removeTitle:!0,removeXMLNS:!0,removeXlink:!0};return typeof e=="boolean"?e?r:{defaultPreset:!1,convertOneStopGradients:!1,convertStyleToAttrs:!1,reusePaths:!1,removeScripts:!1,removeTitle:!1,removeXMLNS:!1,removeXlink:!1}:{...r,...e||{}}}function l(e){const r=[];return e.defaultPreset&&r.push({name:"preset-default",params:{overrides:{removeUselessDefs:!1,removeHiddenElems:!1,removeUnknownsAndDefaults:!1,collapseGroups:!1,mergePaths:!1,convertShapeToPath:!1}}}),e.convertOneStopGradients&&r.push({name:"convertOneStopGradients"}),e.convertStyleToAttrs&&r.push({name:"convertStyleToAttrs"}),e.reusePaths&&r.push({name:"reusePaths"}),e.removeScripts&&r.push({name:"removeScripts"}),e.removeTitle&&r.push({name:"removeTitle"}),e.removeXMLNS&&r.push({name:"removeXMLNS"}),e.removeXlink&&r.push({name:"removeXlink"}),r.push({name:"removeDimensions"}),r}export{c as bakeIcon,p as bakeIcons};
+import { optimize } from 'svgo';
+
+const DEFAULT_SAFE_PRESET = {
+  name: "preset-default",
+  params: {
+    overrides: {
+      removeUselessDefs: false,
+      removeHiddenElems: false,
+      removeUnknownsAndDefaults: false,
+      collapseGroups: false,
+      mergePaths: false,
+      convertShapeToPath: false
+    }
+  }
+};
+const DEFAULT_SAFE_PLUGINS = [{ name: "removeTitle" }, { name: "removeXMLNS" }, { name: "removeXlink" }];
+const CORE_PLUGIN_BLOCKLIST = /* @__PURE__ */ new Set(["prefixIds"]);
+function resolveOptions(userOption) {
+  const userObject = userOption ?? {};
+  return {
+    optimize: userObject.optimize ?? true,
+    svgoOptions: userObject.svgoOptions ?? {}
+  };
+}
+function createSvgoConfig(sourceName, options) {
+  const plugins = [];
+  if (options.optimize) {
+    plugins.push(DEFAULT_SAFE_PRESET);
+    plugins.push(...DEFAULT_SAFE_PLUGINS);
+  }
+  if (options.svgoOptions.plugins != null) {
+    plugins.push(...filterPlugins(options.svgoOptions.plugins));
+  }
+  plugins.push(...createCorePlugins(sourceName));
+  return {
+    multipass: options.svgoOptions.multipass,
+    floatPrecision: options.svgoOptions.floatPrecision,
+    js2svg: options.svgoOptions.js2svg,
+    plugins
+  };
+}
+function filterPlugins(plugins) {
+  return plugins.filter((plugin) => {
+    const name = resolvePluginName(plugin);
+    if (name == null) {
+      return true;
+    }
+    return !CORE_PLUGIN_BLOCKLIST.has(name);
+  });
+}
+function resolvePluginName(plugin) {
+  if (typeof plugin === "string") {
+    return plugin;
+  }
+  if (plugin && typeof plugin === "object" && "name" in plugin && typeof plugin.name === "string") {
+    return plugin.name;
+  }
+  return null;
+}
+function createCorePlugins(sourceName) {
+  return [{ name: "removeDimensions" }, { name: "prefixIds", params: { prefix: `${sourceName}-`, delim: "" } }];
+}
+
+function bakeIcon(source, options) {
+  const resolvedOptions = resolveOptions(options);
+  return {
+    name: source.name,
+    content: convertToSymbol(source, resolvedOptions)
+  };
+}
+function bakeIcons(sources, options) {
+  const resolvedOptions = resolveOptions(options);
+  return sources.map((source) => ({
+    name: source.name,
+    content: convertToSymbol(source, resolvedOptions)
+  }));
+}
+function convertToSymbol(source, options) {
+  if (!source || !source.name || !source.content) {
+    throw new TypeError("Property name and content are required.");
+  }
+  if (!/^[A-Za-z][A-Za-z0-9_-]*$/.test(source.name)) {
+    throw new TypeError("Invalid name. Use letters, numbers, dash, or underscore, starting with a letter.");
+  }
+  const normalizedSource = stripLeadingSvgPreamble(source.content);
+  if (!/^\s*<svg\b/i.test(normalizedSource)) {
+    throw new Error("Parsing failed. Input must start with an <svg> root element.");
+  }
+  let result;
+  try {
+    result = optimize(normalizedSource, createSvgoConfig(source.name, options));
+  } catch (err) {
+    throw new Error(`Parsing failed. ${String(err)}`);
+  }
+  const viewBox = result.data.match(/viewBox="([^"]+)"/)?.[1];
+  if (!viewBox) {
+    throw new Error("Cannot determine viewBox. Provide an SVG with viewBox or width/height attributes.");
+  }
+  const cleanedSvg = stripLeadingSvgPreamble(result.data);
+  return toSymbolRootTag(cleanedSvg, source.name, viewBox);
+}
+function stripLeadingSvgPreamble(content) {
+  return content.replace(/^(?:\uFEFF|\s|<\?xml[\s\S]*?\?>|<!--[\s\S]*?-->|<!DOCTYPE[\s\S]*?>)+/i, "");
+}
+function toSymbolRootTag(svg, symbolId, viewBox) {
+  const rootOpenTag = svg.match(/^\s*<svg\b[^>]*>/i)[0];
+  const preservedAttrs = rootOpenTag.replace(/^\s*<svg\b/i, "").replace(/>\s*$/i, "").replace(/\s+id=(['"])[^'"]*\1/gi, "").replace(/\s+viewBox=(['"])[^'"]*\1/gi, "").replace(/\s+width=(['"])[^'"]*\1/gi, "").replace(/\s+height=(['"])[^'"]*\1/gi, "").trim();
+  const attrs = preservedAttrs ? ` ${preservedAttrs}` : "";
+  const symbolOpenTag = `<symbol id="${symbolId}" viewBox="${viewBox}"${attrs}>`;
+  return svg.replace(/^\s*<svg\b[^>]*>/i, symbolOpenTag).replace(/<\/svg>\s*$/i, "</symbol>").trim();
+}
+
+export { bakeIcon, bakeIcons };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svg-icon-baker",
-  "version": "1.1.3",
+  "version": "1.2.1",
   "description": "A delightful toolkit for baking raw SVG icons into delicious SVG symbol sprites",
   "keywords": [
     "svg",
@@ -17,7 +17,8 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/yangxu52/svg-icon-baker.git"
+    "url": "git+https://github.com/yangxu52/vite-plugin-svg-icons-ng.git",
+    "directory": "packages/svg-icon-baker"
   },
   "license": "MIT",
   "author": "yangxu52",
@@ -40,17 +41,19 @@
   },
   "devDependencies": {
     "@vitest/coverage-v8": "^4.1.0",
+    "rimraf": "^6.1.3",
     "unbuild": "^3.6.1",
     "vitest": "^4.1.0"
   },
   "engines": {
-    "node": "^20.0.0 || ^22.0.0 || >=24.0.0",
-    "pnpm": ">=10.0.0"
+    "node": "^18.0.0 || ^20.0.0 || >=22.0.0"
   },
   "scripts": {
-    "build": "unbuild",
     "dev": "unbuild --stub",
-    "test": "vitest run --coverage",
-    "test:watch": "vitest"
+    "build": "unbuild",
+    "test": "vitest run",
+    "coverage": "vitest run --coverage",
+    "clean": "rimraf dist",
+    "log": "conventional-changelog -p angular --commit-path . -t svg-icon-baker@v"
   }
 }