@iconify/tools 2.2.0 → 2.2.1

package/lib/colors/parse.cjs

@@ -226,6 +226,7 @@ async function parseColors(svg, options = {}) {
               const newValue = await checkColor(
                 elementProp,
                 value
+                // Do not pass third parameter
               );
               if (newValue !== value) {
                 updatedValues = true;

package/lib/colors/parse.mjs

@@ -224,6 +224,7 @@ async function parseColors(svg, options = {}) {
               const newValue = await checkColor(
                 elementProp,
                 value
+                // Do not pass third parameter
               );
               if (newValue !== value) {
                 updatedValues = true;

package/lib/download/git/index.cjs

@@ -58,6 +58,7 @@ async function downloadGitRepo(options) {
   }
   const target = options.target = await export_helpers_prepare.prepareDirectoryForExport({
     ...options,
+    // Always cleanup
     cleanup: true
   });
   if (options.log) {

package/lib/download/git/index.mjs

@@ -56,6 +56,7 @@ async function downloadGitRepo(options) {
   }
   const target = options.target = await prepareDirectoryForExport({
     ...options,
+    // Always cleanup
     cleanup: true
   });
   if (options.log) {

package/lib/download/github/index.cjs

@@ -72,7 +72,13 @@ async function downloadGitHubRepo(options) {
     const filename = rootDir + "/" + files[i];
     const stat = await fs.promises.lstat(filename);
     const isDir = stat.isDirectory();
-    if (stat.isSymbolicLink() || isDir && filename.slice(0 - hashSearch.length) === hashSearch || isDir && options.cleanupOldDirectories !== false || !isDir && options.cleanupOldFiles) {
+    if (
+      // Remove symbolic links
+      stat.isSymbolicLink() || // Remove if directory matches hash to avoid errors extracting zip
+      isDir && filename.slice(0 - hashSearch.length) === hashSearch || // Remove if directory and cleanupOldDirectories is not disabled
+      isDir && options.cleanupOldDirectories !== false || // Remove if file and cleanupOldFiles is enabled
+      !isDir && options.cleanupOldFiles
+    ) {
       try {
         await fs.promises.rm(filename, {
           force: true,

package/lib/download/github/index.mjs

@@ -70,7 +70,13 @@ async function downloadGitHubRepo(options) {
     const filename = rootDir + "/" + files[i];
     const stat = await promises.lstat(filename);
     const isDir = stat.isDirectory();
-    if (stat.isSymbolicLink() || isDir && filename.slice(0 - hashSearch.length) === hashSearch || isDir && options.cleanupOldDirectories !== false || !isDir && options.cleanupOldFiles) {
+    if (
+      // Remove symbolic links
+      stat.isSymbolicLink() || // Remove if directory matches hash to avoid errors extracting zip
+      isDir && filename.slice(0 - hashSearch.length) === hashSearch || // Remove if directory and cleanupOldDirectories is not disabled
+      isDir && options.cleanupOldDirectories !== false || // Remove if file and cleanupOldFiles is enabled
+      !isDir && options.cleanupOldFiles
+    ) {
       try {
         await promises.rm(filename, {
           force: true,

package/lib/download/gitlab/index.cjs

@@ -72,7 +72,13 @@ async function downloadGitLabRepo(options) {
     const filename = rootDir + "/" + files[i];
     const stat = await fs.promises.lstat(filename);
     const isDir = stat.isDirectory();
-    if (stat.isSymbolicLink() || isDir && filename.slice(0 - hashSearch.length) === hashSearch || isDir && options.cleanupOldDirectories !== false || !isDir && options.cleanupOldFiles) {
+    if (
+      // Remove symbolic links
+      stat.isSymbolicLink() || // Remove if directory matches hash to avoid errors extracting zip
+      isDir && filename.slice(0 - hashSearch.length) === hashSearch || // Remove if directory and cleanupOldDirectories is not disabled
+      isDir && options.cleanupOldDirectories !== false || // Remove if file and cleanupOldFiles is enabled
+      !isDir && options.cleanupOldFiles
+    ) {
       try {
         await fs.promises.rm(filename, {
           force: true,

package/lib/download/gitlab/index.mjs

@@ -70,7 +70,13 @@ async function downloadGitLabRepo(options) {
     const filename = rootDir + "/" + files[i];
     const stat = await promises.lstat(filename);
     const isDir = stat.isDirectory();
-    if (stat.isSymbolicLink() || isDir && filename.slice(0 - hashSearch.length) === hashSearch || isDir && options.cleanupOldDirectories !== false || !isDir && options.cleanupOldFiles) {
+    if (
+      // Remove symbolic links
+      stat.isSymbolicLink() || // Remove if directory matches hash to avoid errors extracting zip
+      isDir && filename.slice(0 - hashSearch.length) === hashSearch || // Remove if directory and cleanupOldDirectories is not disabled
+      isDir && options.cleanupOldDirectories !== false || // Remove if file and cleanupOldFiles is enabled
+      !isDir && options.cleanupOldFiles
+    ) {
       try {
         await promises.rm(filename, {
           force: true,

package/lib/export/icon-package.cjs

@@ -45,6 +45,7 @@ async function exportIconPackage(iconSet, options) {
     ...customPackageProps,
     dependencies: dependencies || {
       "@iconify/types": "*"
+      // '^' + (await getTypesVersion()),
     }
   };
   await misc_writeJson.writeJSONFile(dir + "/package.json", packageJSON);

package/lib/export/icon-package.mjs

@@ -43,6 +43,7 @@ async function exportIconPackage(iconSet, options) {
     ...customPackageProps,
     dependencies: dependencies || {
       "@iconify/types": "*"
+      // '^' + (await getTypesVersion()),
     }
   };
   await writeJSONFile(dir + "/package.json", packageJSON);

package/lib/export/json-package.cjs

@@ -75,6 +75,7 @@ async function exportJSONPackage(iconSet, options) {
     iconSet: packageJSONIconSet,
     dependencies: dependencies || {
       "@iconify/types": "*"
+      // '^' + (await getTypesVersion()),
     }
   };
   const dtsContent = [];

package/lib/export/json-package.mjs

@@ -73,6 +73,7 @@ async function exportJSONPackage(iconSet, options) {
     iconSet: packageJSONIconSet,
     dependencies: dependencies || {
       "@iconify/types": "*"
+      // '^' + (await getTypesVersion()),
     }
   };
   const dtsContent = [];

package/lib/icon-set/index.cjs

@@ -17,9 +17,15 @@ function sortThemeKeys(keys) {
   );
 }
 class IconSet {
+  /**
+   * Load icon set
+   */
   constructor(data) {
     this.load(data);
   }
+  /**
+   * Load icon set
+   */
   load(data) {
     this.prefix = data.prefix;
     const defaultProps = iconSet_props.filterProps(data, defaults.defaultIconDimensions, true);
@@ -129,15 +135,27 @@ class IconSet {
     });
     this.lastModified = data.lastModified || 0;
   }
+  /**
+   * Update last modification time
+   */
   updateLastModified(value) {
     this.lastModified = value || Math.floor(Date.now() / 1e3);
   }
+  /**
+   * List icons
+   */
   list(types = ["icon", "variation"]) {
     return Object.keys(this.entries).filter((name) => {
       const type = this.entries[name].type;
       return types.indexOf(type) !== -1;
     });
   }
+  /**
+   * forEach function to loop through all entries.
+   * Supports asynchronous callbacks.
+   *
+   * Callback should return false to stop loop.
+   */
   async forEach(callback, types = ["icon", "variation", "alias"]) {
     const names = this.list(types);
     for (let i = 0; i < names.length; i++) {
@@ -154,6 +172,17 @@ class IconSet {
       }
     }
   }
+  /**
+   * Get parent icons tree
+   *
+   * Returns parent icons list for each icon, null if failed to resolve.
+   * In parent icons list, first element is a direct parent, last is icon. Does not include item.
+   *
+   * Examples:
+   *   'alias3': ['alias2', 'alias1', 'icon']
+   * 	 'icon': []
+   * 	 'bad-icon': null
+   */
   getTree(names) {
     const entries = this.entries;
     const resolved = /* @__PURE__ */ Object.create(null);
@@ -200,6 +229,9 @@ class IconSet {
     tree.forEach(parse);
     return result && full ? { ...defaults.defaultIconProps, ...result } : result;
   }
+  /**
+   * Generate HTML
+   */
   toString(name, customisations = {
     width: "auto",
     height: "auto"
@@ -214,10 +246,16 @@ class IconSet {
     ).join("");
     return `<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"${attributes}>${result.body}</svg>`;
   }
+  /**
+   * Get SVG instance for icon
+   */
   toSVG(name) {
     const html = this.toString(name);
     return html ? new svg_index.SVG(html) : null;
   }
+  /**
+   * Export icon set
+   */
   export(validate = true) {
     const icons = /* @__PURE__ */ Object.create(null);
     const aliases = /* @__PURE__ */ Object.create(null);
@@ -304,6 +342,9 @@ class IconSet {
     minify.minifyIconSet(result);
     return result;
   }
+  /**
+   * Get characters map
+   */
   chars(names) {
     const chars = /* @__PURE__ */ Object.create(null);
     if (!names) {
@@ -318,6 +359,9 @@ class IconSet {
     }
     return chars;
   }
+  /**
+   * Filter icons
+   */
   _filter(callback) {
     const names = [];
     for (const key in this.entries) {
@@ -341,6 +385,9 @@ class IconSet {
     }
     return names;
   }
+  /**
+   * Count icons
+   */
   count() {
     return this._filter((_key, item, icon) => {
       if (item.type === "alias" || item.props.hidden || icon?.hidden) {
@@ -349,6 +396,9 @@ class IconSet {
       return true;
     }).length;
   }
+  /**
+   * Find category by title
+   */
   findCategory(title, add) {
     const categoryItem = Array.from(this.categories).find(
       (item) => item.title === title
@@ -366,6 +416,11 @@ class IconSet {
     }
     return null;
   }
+  /**
+   * Count icons in category, remove category if empty
+   *
+   * Hidden icons and aliases do not count
+   */
   listCategory(category) {
     const categoryItem = typeof category === "string" ? this.findCategory(category, false) : category;
     if (!categoryItem) {
@@ -385,9 +440,17 @@ class IconSet {
     }
     return icons;
   }
+  /**
+   * Check if icon exists
+   */
   exists(name) {
     return !!this.entries[name];
   }
+  /**
+   * Remove icons. Returns number of removed icons
+   *
+   * If removeDependencies is a string, it represents new parent for all aliases of removed icon. New parent cannot be alias or variation.
+   */
   remove(name, removeDependencies = true) {
     const entries = this.entries;
     if (typeof removeDependencies === "string") {
@@ -430,6 +493,9 @@ class IconSet {
     }
     return count;
   }
+  /**
+   * Remove icon
+   */
   rename(oldName, newName) {
     const entries = this.entries;
     if (entries[newName]) {
@@ -458,6 +524,9 @@ class IconSet {
     this.updateLastModified();
     return true;
   }
+  /**
+   * Add/update item
+   */
   setItem(name, item) {
     switch (item.type) {
       case "alias":
@@ -471,6 +540,9 @@ class IconSet {
     this.updateLastModified();
     return true;
   }
+  /**
+   * Add/update icon
+   */
   setIcon(name, icon) {
     return this.setItem(name, {
       type: "icon",
@@ -480,6 +552,9 @@ class IconSet {
       categories: /* @__PURE__ */ new Set()
     });
   }
+  /**
+   * Add/update alias without props
+   */
   setAlias(name, parent) {
     return this.setItem(name, {
       type: "alias",
@@ -487,6 +562,9 @@ class IconSet {
       chars: /* @__PURE__ */ new Set()
     });
   }
+  /**
+   * Add/update alias with props
+   */
   setVariation(name, parent, props) {
     return this.setItem(name, {
       type: "variation",
@@ -495,6 +573,9 @@ class IconSet {
       chars: /* @__PURE__ */ new Set()
     });
   }
+  /**
+   * Icon from SVG. Updates old icon if it exists
+   */
   fromSVG(name, svg) {
     const props = { ...svg.viewBox };
     const body = svg.getBody();
@@ -516,6 +597,9 @@ class IconSet {
       ...props
     });
   }
+  /**
+   * Add or remove character for icon
+   */
   toggleCharacter(iconName, char, add) {
     const item = this.entries[iconName];
     if (!item) {
@@ -527,6 +611,9 @@ class IconSet {
     }
     return false;
   }
+  /**
+   * Add or remove category for icon
+   */
   toggleCategory(iconName, category, add) {
     const item = this.entries[iconName];
     const categoryItem = this.findCategory(category, add);
@@ -543,6 +630,9 @@ class IconSet {
     }
     return false;
   }
+  /**
+   * Find icons that belong to theme
+   */
   checkTheme(prefix) {
     const themes = prefix ? this.prefixes : this.suffixes;
     const keys = sortThemeKeys(Object.keys(themes));

package/lib/icon-set/index.mjs

@@ -15,9 +15,15 @@ function sortThemeKeys(keys) {
   );
 }
 class IconSet {
+  /**
+   * Load icon set
+   */
   constructor(data) {
     this.load(data);
   }
+  /**
+   * Load icon set
+   */
   load(data) {
     this.prefix = data.prefix;
     const defaultProps = filterProps(data, defaultIconDimensions, true);
@@ -127,15 +133,27 @@ class IconSet {
     });
     this.lastModified = data.lastModified || 0;
   }
+  /**
+   * Update last modification time
+   */
   updateLastModified(value) {
     this.lastModified = value || Math.floor(Date.now() / 1e3);
   }
+  /**
+   * List icons
+   */
   list(types = ["icon", "variation"]) {
     return Object.keys(this.entries).filter((name) => {
       const type = this.entries[name].type;
       return types.indexOf(type) !== -1;
     });
   }
+  /**
+   * forEach function to loop through all entries.
+   * Supports asynchronous callbacks.
+   *
+   * Callback should return false to stop loop.
+   */
   async forEach(callback, types = ["icon", "variation", "alias"]) {
     const names = this.list(types);
     for (let i = 0; i < names.length; i++) {
@@ -152,6 +170,17 @@ class IconSet {
       }
     }
   }
+  /**
+   * Get parent icons tree
+   *
+   * Returns parent icons list for each icon, null if failed to resolve.
+   * In parent icons list, first element is a direct parent, last is icon. Does not include item.
+   *
+   * Examples:
+   *   'alias3': ['alias2', 'alias1', 'icon']
+   * 	 'icon': []
+   * 	 'bad-icon': null
+   */
   getTree(names) {
     const entries = this.entries;
     const resolved = /* @__PURE__ */ Object.create(null);
@@ -198,6 +227,9 @@ class IconSet {
     tree.forEach(parse);
     return result && full ? { ...defaultIconProps, ...result } : result;
   }
+  /**
+   * Generate HTML
+   */
   toString(name, customisations = {
     width: "auto",
     height: "auto"
@@ -212,10 +244,16 @@ class IconSet {
     ).join("");
     return `<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"${attributes}>${result.body}</svg>`;
   }
+  /**
+   * Get SVG instance for icon
+   */
   toSVG(name) {
     const html = this.toString(name);
     return html ? new SVG(html) : null;
   }
+  /**
+   * Export icon set
+   */
   export(validate = true) {
     const icons = /* @__PURE__ */ Object.create(null);
     const aliases = /* @__PURE__ */ Object.create(null);
@@ -302,6 +340,9 @@ class IconSet {
     minifyIconSet(result);
     return result;
   }
+  /**
+   * Get characters map
+   */
   chars(names) {
     const chars = /* @__PURE__ */ Object.create(null);
     if (!names) {
@@ -316,6 +357,9 @@ class IconSet {
     }
     return chars;
   }
+  /**
+   * Filter icons
+   */
   _filter(callback) {
     const names = [];
     for (const key in this.entries) {
@@ -339,6 +383,9 @@ class IconSet {
     }
     return names;
   }
+  /**
+   * Count icons
+   */
   count() {
     return this._filter((_key, item, icon) => {
       if (item.type === "alias" || item.props.hidden || icon?.hidden) {
@@ -347,6 +394,9 @@ class IconSet {
       return true;
     }).length;
   }
+  /**
+   * Find category by title
+   */
   findCategory(title, add) {
     const categoryItem = Array.from(this.categories).find(
       (item) => item.title === title
@@ -364,6 +414,11 @@ class IconSet {
     }
     return null;
   }
+  /**
+   * Count icons in category, remove category if empty
+   *
+   * Hidden icons and aliases do not count
+   */
   listCategory(category) {
     const categoryItem = typeof category === "string" ? this.findCategory(category, false) : category;
     if (!categoryItem) {
@@ -383,9 +438,17 @@ class IconSet {
     }
     return icons;
   }
+  /**
+   * Check if icon exists
+   */
   exists(name) {
     return !!this.entries[name];
   }
+  /**
+   * Remove icons. Returns number of removed icons
+   *
+   * If removeDependencies is a string, it represents new parent for all aliases of removed icon. New parent cannot be alias or variation.
+   */
   remove(name, removeDependencies = true) {
     const entries = this.entries;
     if (typeof removeDependencies === "string") {
@@ -428,6 +491,9 @@ class IconSet {
     }
     return count;
   }
+  /**
+   * Remove icon
+   */
   rename(oldName, newName) {
     const entries = this.entries;
     if (entries[newName]) {
@@ -456,6 +522,9 @@ class IconSet {
     this.updateLastModified();
     return true;
   }
+  /**
+   * Add/update item
+   */
   setItem(name, item) {
     switch (item.type) {
       case "alias":
@@ -469,6 +538,9 @@ class IconSet {
     this.updateLastModified();
     return true;
   }
+  /**
+   * Add/update icon
+   */
   setIcon(name, icon) {
     return this.setItem(name, {
       type: "icon",
@@ -478,6 +550,9 @@ class IconSet {
       categories: /* @__PURE__ */ new Set()
     });
   }
+  /**
+   * Add/update alias without props
+   */
   setAlias(name, parent) {
     return this.setItem(name, {
       type: "alias",
@@ -485,6 +560,9 @@ class IconSet {
       chars: /* @__PURE__ */ new Set()
     });
   }
+  /**
+   * Add/update alias with props
+   */
   setVariation(name, parent, props) {
     return this.setItem(name, {
       type: "variation",
@@ -493,6 +571,9 @@ class IconSet {
       chars: /* @__PURE__ */ new Set()
     });
   }
+  /**
+   * Icon from SVG. Updates old icon if it exists
+   */
   fromSVG(name, svg) {
     const props = { ...svg.viewBox };
     const body = svg.getBody();
@@ -514,6 +595,9 @@ class IconSet {
       ...props
     });
   }
+  /**
+   * Add or remove character for icon
+   */
   toggleCharacter(iconName, char, add) {
     const item = this.entries[iconName];
     if (!item) {
@@ -525,6 +609,9 @@ class IconSet {
     }
     return false;
   }
+  /**
+   * Add or remove category for icon
+   */
   toggleCategory(iconName, category, add) {
     const item = this.entries[iconName];
     const categoryItem = this.findCategory(category, add);
@@ -541,6 +628,9 @@ class IconSet {
     }
     return false;
   }
+  /**
+   * Find icons that belong to theme
+   */
   checkTheme(prefix) {
     const themes = prefix ? this.prefixes : this.suffixes;
     const keys = sortThemeKeys(Object.keys(themes));

package/lib/import/figma/index.cjs

@@ -42,10 +42,12 @@ require('../../misc/scan.cjs');
 
 async function importFromFigma(options) {
   const cacheOptions = options.cacheDir ? {
+    // 24 hours
     ttl: options.cacheAPITTL || 60 * 60 * 24,
     dir: options.cacheDir
   } : void 0;
   const cacheSVGOptions = options.cacheDir ? {
+    // 30 days
     ttl: options.cacheSVGTTL || 60 * 60 * 24 * 30,
     dir: options.cacheDir
   } : void 0;
@@ -93,12 +95,15 @@ async function importFromFigma(options) {
     }
   }
   const result = {
+    // Document
     name: document.name,
     version: document.version,
     lastModified: document.lastModified,
+    // Counters
     nodesCount: nodes.nodesCount,
     generatedIconsCount: nodes.generatedIconsCount,
     downloadedIconsCount: nodes.downloadedIconsCount,
+    // Icon set
     iconSet,
     missing
   };

package/lib/import/figma/index.mjs

@@ -40,10 +40,12 @@ import '../../misc/scan.mjs';
 
 async function importFromFigma(options) {
   const cacheOptions = options.cacheDir ? {
+    // 24 hours
     ttl: options.cacheAPITTL || 60 * 60 * 24,
     dir: options.cacheDir
   } : void 0;
   const cacheSVGOptions = options.cacheDir ? {
+    // 30 days
     ttl: options.cacheSVGTTL || 60 * 60 * 24 * 30,
     dir: options.cacheDir
   } : void 0;
@@ -91,12 +93,15 @@ async function importFromFigma(options) {
     }
   }
   const result = {
+    // Document
     name: document.name,
     version: document.version,
     lastModified: document.lastModified,
+    // Counters
     nodesCount: nodes.nodesCount,
     generatedIconsCount: nodes.generatedIconsCount,
     downloadedIconsCount: nodes.downloadedIconsCount,
+    // Icon set
     iconSet,
     missing
   };

package/lib/optimise/svgo.cjs

@@ -26,7 +26,9 @@ function getSVGOPlugins(options) {
     "collapseGroups",
     "sortDefsChildren",
     "sortAttrs",
+    // Plugins that are bugged when using animations
     ...options.animated ? [] : ["removeUselessStrokeAndFill"],
+    // Plugins that modify shapes or are bugged when using animations
     ...options.animated || options.keepShapes ? [] : [
       "removeHiddenElems",
       "convertShapeToPath",
@@ -43,9 +45,12 @@ function getSVGOPlugins(options) {
           noSpaceAfterFlags: true
         }
       },
+      // 'removeOffCanvasPaths', // bugged for some icons
       "reusePaths"
     ],
-    ...options.cleanupIDs !== false ? ["cleanupIds"] : []
+    // Clean up IDs, first run
+    // Sometimes bugs out on animated icons. Do not use with animations!
+    ...!options.animated && options.cleanupIDs !== false ? ["cleanupIds"] : []
   ];
 }
 function runSVGO(svg, options = {}) {

package/lib/optimise/svgo.mjs

@@ -24,7 +24,9 @@ function getSVGOPlugins(options) {
     "collapseGroups",
     "sortDefsChildren",
     "sortAttrs",
+    // Plugins that are bugged when using animations
     ...options.animated ? [] : ["removeUselessStrokeAndFill"],
+    // Plugins that modify shapes or are bugged when using animations
     ...options.animated || options.keepShapes ? [] : [
       "removeHiddenElems",
       "convertShapeToPath",
@@ -41,9 +43,12 @@ function getSVGOPlugins(options) {
           noSpaceAfterFlags: true
         }
       },
+      // 'removeOffCanvasPaths', // bugged for some icons
       "reusePaths"
     ],
-    ...options.cleanupIDs !== false ? ["cleanupIds"] : []
+    // Clean up IDs, first run
+    // Sometimes bugs out on animated icons. Do not use with animations!
+    ...!options.animated && options.cleanupIDs !== false ? ["cleanupIds"] : []
   ];
 }
 function runSVGO(svg, options = {}) {

package/lib/svg/cleanup/root-style.cjs

@@ -12,7 +12,11 @@ require('../parse.cjs');
 
 function cleanupRootStyle(svg) {
   return svg_parseStyle.parseSVGStyle(svg, (item) => {
-    if (item.type === "global" && item.selectorTokens.find((token) => token.type === "at-rule")) {
+    if (
+      // If global style
+      item.type === "global" && // If selector tokens contain at-rule
+      item.selectorTokens.find((token) => token.type === "at-rule")
+    ) {
       return;
     }
     return item.value;

package/lib/svg/cleanup/root-style.mjs

@@ -10,7 +10,11 @@ import '../parse.mjs';
 
 function cleanupRootStyle(svg) {
   return parseSVGStyle(svg, (item) => {
-    if (item.type === "global" && item.selectorTokens.find((token) => token.type === "at-rule")) {
+    if (
+      // If global style
+      item.type === "global" && // If selector tokens contain at-rule
+      item.selectorTokens.find((token) => token.type === "at-rule")
+    ) {
       return;
     }
     return item.value;

package/lib/svg/cleanup/root-svg.cjs

@@ -48,7 +48,12 @@ function cleanupSVGRoot(svg) {
       }
       throw new Error(`Unexpected attribute "${attr}" on <${tagName}>`);
     }
-    if (attr.slice(0, 2) === "on" || attr.slice(0, 5) === "aria-" || attr.slice(0, 6) === "xmlns:") {
+    if (
+      // Events
+      attr.slice(0, 2) === "on" || // aria-stuff
+      attr.slice(0, 5) === "aria-" || // Junk
+      attr.slice(0, 6) === "xmlns:"
+    ) {
       $root.removeAttr(attr);
       return;
     }

package/lib/svg/cleanup/root-svg.mjs

@@ -46,7 +46,12 @@ function cleanupSVGRoot(svg) {
       }
       throw new Error(`Unexpected attribute "${attr}" on <${tagName}>`);
     }
-    if (attr.slice(0, 2) === "on" || attr.slice(0, 5) === "aria-" || attr.slice(0, 6) === "xmlns:") {
+    if (
+      // Events
+      attr.slice(0, 2) === "on" || // aria-stuff
+      attr.slice(0, 5) === "aria-" || // Junk
+      attr.slice(0, 6) === "xmlns:"
+    ) {
       $root.removeAttr(attr);
       return;
     }

package/lib/svg/cleanup/svgo-style.cjs

@@ -19,7 +19,10 @@ async function convertStyleToAttrs(svg) {
   let hasStyle = false;
   await svg_parseStyle.parseSVGStyle(svg, (item) => {
     const prop = item.prop;
-    if (svg_data_attributes.badAttributes.has(prop) || svg_data_attributes.badSoftwareAttributes.has(prop) || svg_data_attributes.badAttributePrefixes.has(prop.split("-").shift())) {
+    if (
+      // Attributes / properties now allowed
+      svg_data_attributes.badAttributes.has(prop) || svg_data_attributes.badSoftwareAttributes.has(prop) || svg_data_attributes.badAttributePrefixes.has(prop.split("-").shift())
+    ) {
       return void 0;
     }
     hasStyle = true;

package/lib/svg/cleanup/svgo-style.mjs

@@ -17,7 +17,10 @@ async function convertStyleToAttrs(svg) {
   let hasStyle = false;
   await parseSVGStyle(svg, (item) => {
     const prop = item.prop;
-    if (badAttributes.has(prop) || badSoftwareAttributes.has(prop) || badAttributePrefixes.has(prop.split("-").shift())) {
+    if (
+      // Attributes / properties now allowed
+      badAttributes.has(prop) || badSoftwareAttributes.has(prop) || badAttributePrefixes.has(prop.split("-").shift())
+    ) {
       return void 0;
     }
     hasStyle = true;

package/lib/svg/data/attributes.cjs

@@ -29,6 +29,7 @@ const badSoftwareAttributes = /* @__PURE__ */ new Set([
   "overflow",
   "marker",
   "white-space",
+  // Font stuff
   "direction"
 ]);
 const badAttributePrefixes = /* @__PURE__ */ new Set([
@@ -37,6 +38,7 @@ const badAttributePrefixes = /* @__PURE__ */ new Set([
   "block",
   "data",
   "aria",
+  // Font stuff
   "text",
   "font",
   "letter",
@@ -44,6 +46,7 @@ const badAttributePrefixes = /* @__PURE__ */ new Set([
   "word",
   "line",
   "writing",
+  // Prefix for browser specific stuff
   ""
 ]);
 const commonAttributes = /* @__PURE__ */ new Set(["id"]);
@@ -155,12 +158,15 @@ const tagSpecificAnimatedAttributes = {
   rect: /* @__PURE__ */ new Set(["x", "y", "width", "height", "rx", "ry"])
 };
 const tagSpecificPresentationalAttributes = {
+  // SVG
   svg: /* @__PURE__ */ new Set(["width", "height", ...presentationalAttributes]),
+  // Defnitions, containers and masks
   clipPath: /* @__PURE__ */ new Set([...presentationalAttributes]),
   defs: /* @__PURE__ */ new Set([]),
   g: /* @__PURE__ */ new Set([...presentationalAttributes]),
   mask: /* @__PURE__ */ new Set(["x", "y", "width", "height", ...presentationalAttributes]),
   symbol: /* @__PURE__ */ new Set(["x", "y", "width", "height", ...presentationalAttributes]),
+  // Use
   use: /* @__PURE__ */ new Set([
     "x",
     "y",
@@ -170,7 +176,9 @@ const tagSpecificPresentationalAttributes = {
     "refY",
     ...presentationalAttributes
   ]),
+  // Marker
   marker: /* @__PURE__ */ new Set([...presentationalAttributes]),
+  // Gradients
   linearGradient: /* @__PURE__ */ new Set([
     "x1",
     "x2",
@@ -188,6 +196,7 @@ const tagSpecificPresentationalAttributes = {
     ...presentationalAttributes
   ]),
   stop: /* @__PURE__ */ new Set(["offset", "stop-color", "stop-opacity"]),
+  // Filters
   feFlood: /* @__PURE__ */ new Set(["flood-color", "flood-opacity"]),
   feDropShadow: /* @__PURE__ */ new Set(["flood-color", "flood-opacity"])
 };
@@ -205,10 +214,13 @@ svg_data_tags.filterChildTags.forEach((tag) => {
   ]);
 });
 const tagSpecificNonPresentationalAttributes = {
+  // SVG
   svg: /* @__PURE__ */ new Set(["xmlns", "viewBox", "preserveAspectRatio"]),
+  // Defnitions, containers and masks
   clipPath: /* @__PURE__ */ new Set(["clipPathUnits"]),
   mask: /* @__PURE__ */ new Set(["maskContentUnits", "maskUnits"]),
   symbol: /* @__PURE__ */ new Set(["viewBox", "preserveAspectRatio"]),
+  // Shapes
   circle: /* @__PURE__ */ new Set([...otherShapeAttributes]),
   ellipse: /* @__PURE__ */ new Set([...otherShapeAttributes]),
   line: /* @__PURE__ */ new Set([...otherShapeAttributes]),
@@ -216,7 +228,9 @@ const tagSpecificNonPresentationalAttributes = {
   polygon: /* @__PURE__ */ new Set([...otherShapeAttributes]),
   polyline: /* @__PURE__ */ new Set([...otherShapeAttributes]),
   rect: /* @__PURE__ */ new Set([...otherShapeAttributes]),
+  // Use
   use: /* @__PURE__ */ new Set(["href"]),
+  // Marker
   marker: /* @__PURE__ */ new Set([
     "markerHeight",
     "markerUnits",
@@ -227,6 +241,7 @@ const tagSpecificNonPresentationalAttributes = {
     "refY",
     "viewBox"
   ]),
+  // Animations
   animate: /* @__PURE__ */ new Set([
     ...animationTimingAttributes,
     ...animationValueAttributes,
@@ -256,8 +271,10 @@ const tagSpecificNonPresentationalAttributes = {
     ...otherAnimationAttributes
   ]),
   mpath: /* @__PURE__ */ new Set(["href"]),
+  // Gradients
   linearGradient: /* @__PURE__ */ new Set([...commonGradientAttributes]),
   radialGradient: /* @__PURE__ */ new Set([...commonGradientAttributes]),
+  // Filters
   feSpotLight: /* @__PURE__ */ new Set([
     "x",
     "y",

package/lib/svg/data/attributes.mjs

@@ -27,6 +27,7 @@ const badSoftwareAttributes = /* @__PURE__ */ new Set([
   "overflow",
   "marker",
   "white-space",
+  // Font stuff
   "direction"
 ]);
 const badAttributePrefixes = /* @__PURE__ */ new Set([
@@ -35,6 +36,7 @@ const badAttributePrefixes = /* @__PURE__ */ new Set([
   "block",
   "data",
   "aria",
+  // Font stuff
   "text",
   "font",
   "letter",
@@ -42,6 +44,7 @@ const badAttributePrefixes = /* @__PURE__ */ new Set([
   "word",
   "line",
   "writing",
+  // Prefix for browser specific stuff
   ""
 ]);
 const commonAttributes = /* @__PURE__ */ new Set(["id"]);
@@ -153,12 +156,15 @@ const tagSpecificAnimatedAttributes = {
   rect: /* @__PURE__ */ new Set(["x", "y", "width", "height", "rx", "ry"])
 };
 const tagSpecificPresentationalAttributes = {
+  // SVG
   svg: /* @__PURE__ */ new Set(["width", "height", ...presentationalAttributes]),
+  // Defnitions, containers and masks
   clipPath: /* @__PURE__ */ new Set([...presentationalAttributes]),
   defs: /* @__PURE__ */ new Set([]),
   g: /* @__PURE__ */ new Set([...presentationalAttributes]),
   mask: /* @__PURE__ */ new Set(["x", "y", "width", "height", ...presentationalAttributes]),
   symbol: /* @__PURE__ */ new Set(["x", "y", "width", "height", ...presentationalAttributes]),
+  // Use
   use: /* @__PURE__ */ new Set([
     "x",
     "y",
@@ -168,7 +174,9 @@ const tagSpecificPresentationalAttributes = {
     "refY",
     ...presentationalAttributes
   ]),
+  // Marker
   marker: /* @__PURE__ */ new Set([...presentationalAttributes]),
+  // Gradients
   linearGradient: /* @__PURE__ */ new Set([
     "x1",
     "x2",
@@ -186,6 +194,7 @@ const tagSpecificPresentationalAttributes = {
     ...presentationalAttributes
   ]),
   stop: /* @__PURE__ */ new Set(["offset", "stop-color", "stop-opacity"]),
+  // Filters
   feFlood: /* @__PURE__ */ new Set(["flood-color", "flood-opacity"]),
   feDropShadow: /* @__PURE__ */ new Set(["flood-color", "flood-opacity"])
 };
@@ -203,10 +212,13 @@ filterChildTags.forEach((tag) => {
   ]);
 });
 const tagSpecificNonPresentationalAttributes = {
+  // SVG
   svg: /* @__PURE__ */ new Set(["xmlns", "viewBox", "preserveAspectRatio"]),
+  // Defnitions, containers and masks
   clipPath: /* @__PURE__ */ new Set(["clipPathUnits"]),
   mask: /* @__PURE__ */ new Set(["maskContentUnits", "maskUnits"]),
   symbol: /* @__PURE__ */ new Set(["viewBox", "preserveAspectRatio"]),
+  // Shapes
   circle: /* @__PURE__ */ new Set([...otherShapeAttributes]),
   ellipse: /* @__PURE__ */ new Set([...otherShapeAttributes]),
   line: /* @__PURE__ */ new Set([...otherShapeAttributes]),
@@ -214,7 +226,9 @@ const tagSpecificNonPresentationalAttributes = {
   polygon: /* @__PURE__ */ new Set([...otherShapeAttributes]),
   polyline: /* @__PURE__ */ new Set([...otherShapeAttributes]),
   rect: /* @__PURE__ */ new Set([...otherShapeAttributes]),
+  // Use
   use: /* @__PURE__ */ new Set(["href"]),
+  // Marker
   marker: /* @__PURE__ */ new Set([
     "markerHeight",
     "markerUnits",
@@ -225,6 +239,7 @@ const tagSpecificNonPresentationalAttributes = {
     "refY",
     "viewBox"
   ]),
+  // Animations
   animate: /* @__PURE__ */ new Set([
     ...animationTimingAttributes,
     ...animationValueAttributes,
@@ -254,8 +269,10 @@ const tagSpecificNonPresentationalAttributes = {
     ...otherAnimationAttributes
   ]),
   mpath: /* @__PURE__ */ new Set(["href"]),
+  // Gradients
   linearGradient: /* @__PURE__ */ new Set([...commonGradientAttributes]),
   radialGradient: /* @__PURE__ */ new Set([...commonGradientAttributes]),
+  // Filters
   feSpotLight: /* @__PURE__ */ new Set([
     "x",
     "y",

package/lib/svg/data/tags.cjs

@@ -1,23 +1,29 @@
 'use strict';
 
 const badTags = /* @__PURE__ */ new Set([
+  // Nasty stuff or external resource
   "foreignObject",
   "script",
   "image",
   "feImage",
+  // Deprecated
   "animateColor",
   "altGlyph",
+  // Text
   "text",
   "tspan",
   "switch",
   "textPath",
+  // Font
   "font",
   "font-face",
   "glyph",
   "missing-glyph",
   "hkern",
   "vhern",
+  // View
   "view",
+  // Link
   "a"
 ]);
 const unsupportedTags = /* @__PURE__ */ new Set(["metadata", "desc", "title"]);

package/lib/svg/data/tags.mjs

@@ -1,21 +1,27 @@
 const badTags = /* @__PURE__ */ new Set([
+  // Nasty stuff or external resource
   "foreignObject",
   "script",
   "image",
   "feImage",
+  // Deprecated
   "animateColor",
   "altGlyph",
+  // Text
   "text",
   "tspan",
   "switch",
   "textPath",
+  // Font
   "font",
   "font-face",
   "glyph",
   "missing-glyph",
   "hkern",
   "vhern",
+  // View
   "view",
+  // Link
   "a"
 ]);
 const unsupportedTags = /* @__PURE__ */ new Set(["metadata", "desc", "title"]);

package/lib/svg/index.cjs

@@ -4,9 +4,15 @@ const cheerio = require('cheerio');
 const utils = require('@iconify/utils');
 
 class SVG {
+  /**
+   * Constructor
+   */
   constructor(content) {
     this.load(content);
   }
+  /**
+   * Get SVG as string
+   */
   toString(customisations) {
     if (customisations) {
       const data = utils.iconToSVG(this.getIcon(), customisations);
@@ -36,9 +42,15 @@ class SVG {
     }
     return this.$svg.html();
   }
+  /**
+   * Get SVG as string without whitespaces
+   */
   toMinifiedString(customisations) {
     return utils.trimSVG(this.toString(customisations));
   }
+  /**
+   * Get body
+   */
   getBody() {
     const $root = this.$svg(":root");
     const attribs = $root.get(0).attribs;
@@ -54,6 +66,9 @@ class SVG {
     }
     return utils.trimSVG(this.$svg("svg").html());
   }
+  /**
+   * Get icon as IconifyIcon
+   */
   getIcon() {
     const props = this.viewBox;
     const body = this.getBody();
@@ -62,6 +77,11 @@ class SVG {
       body
     };
   }
+  /**
+   * Load SVG
+   *
+   * @param {string} content
+   */
   load(content) {
     function remove(str1, str2, append) {
       let start = 0;

package/lib/svg/index.mjs

@@ -2,9 +2,15 @@ import cheerio from 'cheerio';
 import { iconToSVG, trimSVG } from '@iconify/utils';
 
 class SVG {
+  /**
+   * Constructor
+   */
   constructor(content) {
     this.load(content);
   }
+  /**
+   * Get SVG as string
+   */
   toString(customisations) {
     if (customisations) {
       const data = iconToSVG(this.getIcon(), customisations);
@@ -34,9 +40,15 @@ class SVG {
     }
     return this.$svg.html();
   }
+  /**
+   * Get SVG as string without whitespaces
+   */
   toMinifiedString(customisations) {
     return trimSVG(this.toString(customisations));
   }
+  /**
+   * Get body
+   */
   getBody() {
     const $root = this.$svg(":root");
     const attribs = $root.get(0).attribs;
@@ -52,6 +64,9 @@ class SVG {
     }
     return trimSVG(this.$svg("svg").html());
   }
+  /**
+   * Get icon as IconifyIcon
+   */
   getIcon() {
     const props = this.viewBox;
     const body = this.getBody();
@@ -60,6 +75,11 @@ class SVG {
       body
     };
   }
+  /**
+   * Load SVG
+   *
+   * @param {string} content
+   */
   load(content) {
     function remove(str1, str2, append) {
       let start = 0;

package/package.json

@@ -3,7 +3,7 @@
   "type": "module",
   "description": "Collection of functions for cleaning up and parsing SVG for Iconify project",
   "author": "Vjacheslav Trushkin",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "license": "MIT",
   "bugs": "https://github.com/iconify/tools/issues",
   "homepage": "https://github.com/iconify/tools",
@@ -16,35 +16,35 @@
   "types": "./lib/index.d.ts",
   "dependencies": {
     "@iconify/types": "^2.0.0",
-    "@iconify/utils": "^2.0.9",
+    "@iconify/utils": "^2.0.12",
     "@types/cheerio": "^0.22.31",
     "@types/node-fetch": "^2.6.2",
     "@types/tar": "^6.1.3",
     "cheerio": "^1.0.0-rc.12",
     "extract-zip": "^2.0.1",
     "local-pkg": "^0.4.2",
-    "node-fetch": "^2.6.7",
+    "node-fetch": "^2.6.8",
     "pathe": "^1.0.0",
     "svgo": "^3.0.2",
     "tar": "^6.1.13"
   },
   "devDependencies": {
-    "@types/jest": "^29.2.4",
-    "@types/node": "^18.11.17",
-    "@typescript-eslint/eslint-plugin": "^5.47.0",
-    "@typescript-eslint/parser": "^5.47.0",
+    "@types/jest": "^29.2.5",
+    "@types/node": "^18.11.18",
+    "@typescript-eslint/eslint-plugin": "^5.48.1",
+    "@typescript-eslint/parser": "^5.48.1",
     "cross-env": "^7.0.3",
-    "eslint": "^8.30.0",
-    "eslint-config-prettier": "^8.5.0",
+    "eslint": "^8.32.0",
+    "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-jasmine": "^4.1.3",
     "eslint-plugin-prettier": "^4.2.1",
     "jasmine": "^4.5.0",
     "jest": "^29.3.1",
-    "prettier": "^2.8.1",
+    "prettier": "^2.8.3",
     "rimraf": "^3.0.2",
-    "ts-jest": "^29.0.3",
+    "ts-jest": "^29.0.5",
     "typescript": "^4.9.4",
-    "unbuild": "^1.0.2"
+    "unbuild": "^1.1.1"
   },
   "exports": {
     "./*": "./*",