added remove-tags-by-name.js

README.md

@@ -28,15 +28,15 @@ Here's an example of a tag:
 
 ## get attribute
 ```javascript
-const getAttribute = require("xml-utils/get-attribute");
+const getAttribute = require("xml-utils/get-attribute.js");
 const xml = `<MDI key="INTERLEAVE">PIXEL</MDI>`;
 const key = getAttribute(xml, "key");
 // key is "INTERLEAVE"
 ```
 
 ## find one tag by name
 ```javascript
-const findTagByName = require("xml-utils/find-tag-by-name");
+const findTagByName = require("xml-utils/find-tag-by-name.js");
 
 const xml = `<Metadata domain="IMAGE_STRUCTURE"><MDI key="INTERLEAVE">PIXEL</MDI></Metadata>`
 const tag = findTagByName(xml, "MDI");
@@ -50,7 +50,7 @@ tag is
 ```
 ## find multiple tags with the same name
 ```javascript
-const findTagsByName = require("xml-utils/find-tags-by-name");
+const findTagsByName = require("xml-utils/find-tags-by-name.js");
 const xml = `
     <Metadata>
       <MDI key="SourceBandIndex">1</MDI>
@@ -65,7 +65,7 @@ const tags = findTagsByName(xml, "MDI");
 ```
 ## find one tag by path
 ```javascript
-const findTagByPath = require("xml-utils/find-tag-by-path");
+const findTagByPath = require("xml-utils/find-tag-by-path.js");
 const xml = `
        <gmd:referenceSystemIdentifier>
          <gmd:RS_Identifier>
@@ -87,14 +87,14 @@ const tag = findTagByPath(xml, ["gmd:RS_Identifier", "gmd:code", "gco:CharacterS
 ## find multiple tags by path
 To get an array of tags that follow a path:
 ```javascript
-const findTagsByPath = require("xml-utils/find-tags-by-path");
+const findTagsByPath = require("xml-utils/find-tags-by-path.js");
 const tags = findTagByPath(xml, ["Metadata", "MDI"]);
 // tags is an array of tags
 ```
 
 ## remove comments
 ```javascript
-const removeComments = require("xml-utils/remove-comments");
+const removeComments = require("xml-utils/remove-comments.js");
 const xml = `<list>
   <!--<A/>-->
   <B/>
@@ -103,6 +103,15 @@ removeComments(xml);
 "<list>\n  \n<B/><list>";
 ```
 
+## remove tags by name
+```js
+const removeTagsByName = require("xml-utils/remove-tags-by-name.js");
+
+const xml = "<ul><li>A</li><li>B</li></ul>";
+removeTagsByName(xml, "li")
+"<ul></ul>"
+```
+
 
 ## setup
 download test files with:

index.d.ts

@@ -25,3 +25,5 @@ export function findTagByPath(
 ): Tag | undefined;
 
 export function getAttribute(tag: string | Tag, attributeName: string, options?: { debug?: boolean } ): string;
+
+export function removeTagsByName(xml: string, tagName: string, options?: { debug?: boolean }): string;

index.js

@@ -1,15 +1,17 @@
-const getAttribute = require("./get-attribute");
-const findTagByName = require("./find-tag-by-name");
-const findTagsByName = require("./find-tags-by-name");
-const findTagByPath = require("./find-tag-by-path");
-const findTagsByPath = require("./find-tags-by-path");
-const removeComments = require("./remove-comments");
+const getAttribute = require("./get-attribute.js");
+const findTagByName = require("./find-tag-by-name.js");
+const findTagsByName = require("./find-tags-by-name.js");
+const findTagByPath = require("./find-tag-by-path.js");
+const findTagsByPath = require("./find-tags-by-path.js");
+const removeComments = require("./remove-comments.js");
+const removeTagsByName = require("./remove-tags-by-name.js");
 
 module.exports = {
   getAttribute,
   findTagByName,
   findTagsByName,
   findTagByPath,
   findTagsByPath,
-  removeComments
+  removeComments,
+  removeTagsByName
 };

package.json

@@ -27,7 +27,9 @@
     "./get-attribute": "./get-attribute.js",
     "./get-attribute.js": "./get-attribute.js",
     "./remove-comments": "./remove-comments.js",
-    "./remove-comments.js": "./remove-comments.js"
+    "./remove-comments.js": "./remove-comments.js",
+    "./remove-tags-by-name": "./remove-tags-by-name",
+    "./remove-tags-by-name.js": "./remove-tags-by-name.js"
   },
   "files": [
     "index.d.ts",

remove-tags-by-name.js

@@ -0,0 +1,14 @@
+const findTagByName = require("./find-tag-by-name.js");
+
+function removeTagsByName(xml, tagName, options) {
+  const debug = (options && options.debug) || false;
+  let tag;
+  while ((tag = findTagByName(xml, tagName, { debug }))) {
+    xml = xml.substring(0, tag.start) + xml.substring(tag.end);
+    if (debug) console.log("[xml-utils] removed:", tag);
+  }
+  return xml;
+}
+
+module.exports = removeTagsByName;
+module.exports.default = removeTagsByName;

test/test.js

@@ -9,6 +9,7 @@ const findTagByPath = require("../find-tag-by-path.js");
 const findTagsByPath = require("../find-tags-by-path.js");
 const getAttribute = require("../get-attribute.js");
 const removeComments = require("../remove-comments.js");
+const removeTagsByName = require("../remove-tags-by-name.js");
 
 const iso = readFileSync("test/data/iso.xml", "utf-8");
 const mrf = readFileSync("test/data/m_3008501_ne_16_1_20171018.mrf", "utf-8");
@@ -199,3 +200,13 @@ test("should handle nested tags", ({ eq }) => {
 test("getAttribute with single quotes", ({ eq }) => {
   eq(getAttribute("<link href='https://example.org'/>", "href"), "https://example.org");
 });
+
+test("removeTagsByName", ({ eq }) => {
+  const xml = `
+  <ul>
+    <li>A</li>
+    <li>B</li>
+  </ul>
+  `;
+  eq(removeTagsByName(xml, "li").trim(), "<ul>\n    \n    \n  </ul>");
+});

test/test.ts

@@ -1,7 +1,7 @@
 import test from "flug";
 // @ts-ignore
 import { readFileSync } from "node:fs";
-import { findTagByName, findTagsByName, findTagByPath, findTagsByPath, getAttribute } from "../index";
+import { findTagByName, findTagsByName, findTagByPath, findTagsByPath, getAttribute, removeTagsByName } from "../index";
 
 const iso = readFileSync("test/data/iso.xml", "utf-8");
 const mrf = readFileSync("test/data/m_3008501_ne_16_1_20171018.mrf", "utf-8");
@@ -103,3 +103,7 @@ test("should handle nested tags", ({ eq }) => {
   ]);
   eq(findTagByPath(xml, ["Thing"])!.outer, xml);
 });
+
+test("removeTagsByName", ({ eq }) => {
+  eq(removeTagsByName("<ul><li>A</li><li>B</li></ul>", "li"), "<ul></ul>");
+});