feat: tagNameProcessor callback receives nodes as second argument

Author: lpatiny

src/__tests__/tagProcessors.test.ts

@@ -16,6 +16,19 @@ describe('XMLParser', () => {
     });
 
     expect(result).toStrictEqual({ ANY_NAME: { PERSON: 'end' } });
+
+    const tagNames: Array<{ name: string; nodes: string[] }> = [];
+    parse(xmlData, {
+      tagNameProcessor: (name, nodes) => {
+        tagNames.push({ name, nodes: nodes.map((c) => c.tagName) });
+        return name.toUpperCase();
+      },
+    });
+
+    expect(tagNames).toStrictEqual([
+      { name: 'any_name', nodes: ['any_name'] },
+      { name: 'person', nodes: ['person'] },
+    ]);
   });
 
   it('attribute name processor', () => {

src/traversable/defaultOptions.ts

@@ -63,7 +63,7 @@ export interface ParseOptions {
    * Callback to process tag names
    * @default (name:string) => name
    */
-  tagNameProcessor?: (name: string) => string;
+  tagNameProcessor?: (name: string, nodes: XMLNode[]) => string;
   /**
    * Callback to process attribute names
    * @default (name:string) => `$${name}`

src/traversableToJSON.ts

@@ -63,15 +63,17 @@ export function traversableToJSON(
   }
 
   for (const tagName in node.children) {
-    const newTagName = tagNameProcessor ? tagNameProcessor(tagName) : tagName;
-    const children = node.children[tagName];
-    if (children?.length > 1) {
+    const nodes = node.children[tagName];
+    const newTagName = tagNameProcessor
+      ? tagNameProcessor(tagName, nodes)
+      : tagName;
+    if (nodes?.length > 1) {
       result[tagName] = [];
-      for (const child of children) {
+      for (const child of nodes) {
         result[newTagName].push(traversableToJSON(child, options, tagName));
       }
     } else {
-      const subResult = traversableToJSON(children[0], options, tagName);
+      const subResult = traversableToJSON(nodes[0], options, tagName);
       const asArray =
         (arrayMode === true && typeof subResult === 'object') ||
         isTagNameInArrayMode(