Refactor removeUnusedNS plugin (#1559)

- covered with types
- migrated to visitor plugin api
- dropped traverse utility which is replaced by visitor

lib/xast.js

@@ -55,26 +55,6 @@ const closestByName = (node, name) => {
 };
 exports.closestByName = closestByName;
 
-const traverseBreak = Symbol();
-exports.traverseBreak = traverseBreak;
-
-/**
- * @type {(node: any, fn: any) => any}
- */
-const traverse = (node, fn) => {
-  if (fn(node) === traverseBreak) {
-    return traverseBreak;
-  }
-  if (node.type === 'root' || node.type === 'element') {
-    for (const child of node.children) {
-      if (traverse(child, fn) === traverseBreak) {
-        return traverseBreak;
-      }
-    }
-  }
-};
-exports.traverse = traverse;
-
 const visitSkip = Symbol();
 exports.visitSkip = visitSkip;
 

plugins/removeUnusedNS.js

@@ -1,82 +1,61 @@
 'use strict';
 
-const { traverse } = require('../lib/xast.js');
-const { parseName } = require('../lib/svgo/tools.js');
-
+exports.type = 'visitor';
 exports.name = 'removeUnusedNS';
-
-exports.type = 'full';
-
 exports.active = true;
-
 exports.description = 'removes unused namespaces declaration';
 
 /**
- * Remove unused namespaces declaration.
- *
- * @param {Object} item current iteration item
- * @return {Boolean} if false, item will be filtered out
+ * Remove unused namespaces declaration from svg element
+ * which are not used in elements or attributes
  *
  * @author Kir Belevich
- */
-exports.fn = function (root) {
-  let svgElem;
-  const xmlnsCollection = [];
-
-  /**
-   * Remove namespace from collection.
  *
-   * @param {String} ns namescape name
+ * @type {import('../lib/types').Plugin<void>}
  */
-  function removeNSfromCollection(ns) {
-    const pos = xmlnsCollection.indexOf(ns);
-
-    // if found - remove ns from the namespaces collection
-    if (pos > -1) {
-      xmlnsCollection.splice(pos, 1);
-    }
-  }
-
-  traverse(root, (node) => {
-    if (node.type === 'element') {
-      if (node.name === 'svg') {
+exports.fn = () => {
+  /**
+   * @type {Set<string>}
+   */
+  const unusedNamespaces = new Set();
+  return {
+    element: {
+      enter: (node, parentNode) => {
+        // collect all namespaces from svg element
+        // (such as xmlns:xlink="http://www.w3.org/1999/xlink")
+        if (node.name === 'svg' && parentNode.type === 'root') {
           for (const name of Object.keys(node.attributes)) {
-          const { prefix, local } = parseName(name);
-          // collect namespaces
-          if (prefix === 'xmlns' && local) {
-            xmlnsCollection.push(local);
+            if (name.startsWith('xmlns:')) {
+              const local = name.slice('xmlns:'.length);
+              unusedNamespaces.add(local);
             }
           }
-
-        // if svg element has ns-attr
-        if (xmlnsCollection.length) {
-          // save svg element
-          svgElem = node;
+        }
+        if (unusedNamespaces.size !== 0) {
+          // preserve namespace used in nested elements names
+          if (node.name.includes(':')) {
+            const [ns] = node.name.split(':');
+            if (unusedNamespaces.has(ns)) {
+              unusedNamespaces.delete(ns);
             }
           }
-
-      if (xmlnsCollection.length) {
-        const { prefix } = parseName(node.name);
-        // check node for the ns-attrs
-        if (prefix) {
-          removeNSfromCollection(prefix);
-        }
-
-        // check each attr for the ns-attrs
+          // preserve namespace used in nested elements attributes
           for (const name of Object.keys(node.attributes)) {
-          const { prefix } = parseName(name);
-          removeNSfromCollection(prefix);
+            if (name.includes(':')) {
+              const [ns] = name.split(':');
+              unusedNamespaces.delete(ns);
             }
           }
         }
-  });
-
-  // remove svg element ns-attributes if they are not used even once
-  if (xmlnsCollection.length) {
-    for (const name of xmlnsCollection) {
-      delete svgElem.attributes['xmlns:' + name];
+      },
+      exit: (node, parentNode) => {
+        // remove unused namespace attributes from svg element
+        if (node.name === 'svg' && parentNode.type === 'root') {
+          for (const name of unusedNamespaces) {
+            delete node.attributes[`xmlns:${name}`];
           }
         }
-
-  return root;
+      },
+    },
+  };
 };

tsconfig.json

@@ -24,7 +24,6 @@
     "plugins/removeDimensions.js",
     "plugins/removeEmptyAttrs.js",
     "plugins/removeNonInheritableGroupAttrs.js",
-    "plugins/removeUnusedNS.js",
     "plugins/removeXMLNS.js",
     "plugins/sortAttrs.js",
     "plugins/removeEmptyContainers.js",