Merge pull request #4 from DanielJDufour/remove-comments

remove comments

README.md

@@ -92,6 +92,17 @@ const tags = findTagByPath(xml, ["Metadata", "MDI"]);
 // tags is an array of tags
 ```
 
+## remove comments
+```javascript
+const removeComments = require("xml-utils/remove-comments");
+const xml = `<list>
+  <!--<A/>-->
+  <B/>
+</list>`;
+removeComments(xml);
+"<list>\n  \n<B/><list>";
+```
+
 
 ## setup
 download test files with:

index.js

@@ -3,11 +3,13 @@ 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");
 
 module.exports = {
   getAttribute,
   findTagByName,
   findTagsByName,
   findTagByPath,
-  findTagsByPath
+  findTagsByPath,
+  removeComments
 };

package.json

@@ -14,7 +14,8 @@
     "find-tags-by-path.js",
     "get-attribute.js",
     "index-of-match.js",
-    "index-of-match-end.js"
+    "index-of-match-end.js",
+    "remove-comments.js"
   ],
   "scripts": {
     "f": "npm run format",

remove-comments.js

@@ -0,0 +1,6 @@
+function removeComments(xml) {
+  return xml.replace(/<!--[^]*-->/g, "");
+}
+
+module.exports = removeComments;
+module.exports.default = removeComments;

test/test.js

@@ -8,13 +8,26 @@ 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 getAttribute = require("../get-attribute.js");
+const removeComments = require("../remove-comments.js");
 
 const iso = readFileSync("test/data/iso.xml", "utf-8");
 const mrf = readFileSync("test/data/m_3008501_ne_16_1_20171018.mrf", "utf-8");
 const tiffAux = readFileSync("test/data/rgb_raster.tif.aux.xml", "utf-8");
 
 const nested = "<Thing><Thing attr=1></Thing><Thing attr=2></Thing></Thing>";
 
+const commented = `<Thing>
+<!--
+  <Thing attr=1></Thing>
+-->
+<Thing attr=2></Thing>
+</Thing>`;
+
+test("removing comments", ({ eq }) => {
+  eq(removeComments(commented), "<Thing>\n\n<Thing attr=2></Thing>\n</Thing>");
+  eq(removeComments("<A><!--<B/>--><!--<C/>--></A>"), "<A></A>");
+});
+
 test("count substring", ({ eq }) => {
   eq(countSubstring(nested, "<namespace:name"), 0);
   eq(countSubstring(nested, "<Test"), 0);

test/test.ts

@@ -1,13 +1,11 @@
 import test from "flug";
-import { readFileSync } from "fs";
+import { readFileSync } from "node:fs";
 import { findTagByName, findTagsByName, findTagByPath, findTagsByPath, getAttribute } 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");
 const tiffAux = readFileSync("test/data/rgb_raster.tif.aux.xml", "utf-8");
 
-const nested = "<Thing><Thing attr=1></Thing><Thing attr=2></Thing></Thing>";
-
 test("should find all the urls in iso.xml", ({ eq }) => {
   const urls = findTagsByName(iso, "gmd:URL");
   eq(urls[0].inner, "http://geomap.arpa.veneto.it/layers/geonode%3Aatlanteil");