Merge branch 'master' of https://github.com/oozcitak/xmlbuilder2

oozcitak · Apr 2, 2022 · 9605208 · 9605208
2 parents fe8e3d4 + dd2623a
commit 9605208
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 3 deletions.
diff --git a/docs/pages/using-with-external-libraries.md b/docs/pages/using-with-external-libraries.md
@@ -59,6 +59,6 @@ const result = xml.validate(xsd); // true
 ```
 
 {% capture ts_tip %}
-  `XMLBuilder2` uses its own TypeScript interfaces for DOM nodes; which typically will not be compatible withe the interfaces exported by other libraries. TypeScript users should cast those interfaces accordingly to prevent TS 2345 errors.
+  `XMLBuilder2` uses its own TypeScript interfaces for DOM nodes; which typically will not be compatible with the interfaces exported by other libraries. TypeScript users should cast those interfaces accordingly to prevent TS 2345 errors.
 {% endcapture %}
-{% include warning.html content=ts_tip %}
+{% include warning.html content=ts_tip %}
diff --git a/src/interfaces.ts b/src/interfaces.ts
@@ -37,6 +37,12 @@ export interface XMLBuilderOptions {
    * objects to nodes
    */
   ignoreConverters: boolean
+
+  /**
+   * Whether whitespace-only text nodes are skipped or not.
+   */
+  skipWhitespaceOnlyText: boolean
+
   /** 
    * Defines string keys used while converting JS objects to nodes.
    */
@@ -116,6 +122,7 @@ export const DefaultBuilderOptions: XMLBuilderOptions = {
   keepNullNodes: false,
   keepNullAttributes: false,
   ignoreConverters: false,
+  skipWhitespaceOnlyText: true,
   convert: {
     att: "@",
     ins: "?",

diff --git a/src/readers/XMLReader.ts b/src/readers/XMLReader.ts
@@ -3,6 +3,7 @@ import {
   TokenType, DeclarationToken, DocTypeToken, CDATAToken, CommentToken,
   TextToken, PIToken, ElementToken
 } from "@oozcitak/dom/lib/parser/interfaces"
+import { NodeType } from "@oozcitak/dom/lib/dom/interfaces"
 import { namespace as infraNamespace } from "@oozcitak/infra"
 import { namespace_extractQName } from "@oozcitak/dom/lib/algorithm"
 import { XMLBuilder, XMLBuilderOptions } from "../interfaces"
@@ -20,7 +21,7 @@ export class XMLReader extends BaseReader<string> {
    * @param str - XML document string to parse
    */
   _parse(node: XMLBuilder, str: string): XMLBuilder {
-    const lexer = new XMLStringLexer(str, { skipWhitespaceOnlyText: true })
+    const lexer = new XMLStringLexer(str, { skipWhitespaceOnlyText: this._builderOptions.skipWhitespaceOnlyText })
 
     let lastChild = node
     let context = node
@@ -62,6 +63,7 @@ export class XMLReader extends BaseReader<string> {
           context = this.instruction(context, this.sanitize(pi.target), this.sanitize(pi.data)) || context
           break
         case TokenType.Text:
+          if(context.node.nodeType === NodeType.Document) break
           const text = <TextToken>token
           context = this.text(context, this._decodeText(this.sanitize(text.data))) || context
           break

diff --git a/test/readers/XMLReader.custom.test.ts b/test/readers/XMLReader.custom.test.ts
@@ -91,4 +91,31 @@ describe('custom XMLReader', () => {
     })
   })
 
+  test("skip whitespace only text", () => {
+    const xml = $$.t`
+    <?xml version="1.0"?>
+    <root>
+      <ele>      </ele>
+    </root>`
+
+    const doc = $$.create({ skipWhitespaceOnlyText: true }, xml).doc()
+    expect(doc.end()).toBe(`<?xml version="1.0"?><root><ele/></root>`)
+  })
+
+  test("retain whitespace only text", () => {
+    const xml = $$.t`
+    <?xml version="1.0"?>
+    <root>
+      <ele>    </ele>
+    </root>`
+
+    const doc = $$.create({ skipWhitespaceOnlyText: false }, xml).doc()
+
+    expect(doc.end()).toBe(
+      $$.t`
+      <?xml version="1.0"?><root>
+        <ele>    </ele>
+      </root>
+      `)
+  })
 })