Updating example elements in README and tests; remove unused readUntil method from xmlParser

daniel-sc · daniel-sc · commit 145e229a5ee5 · 2025-02-27T10:52:24.000+01:00
diff --git a/README.md b/README.md
@@ -24,8 +24,9 @@ The following XML:
 <?xml version="1.0" encoding="UTF-8"?>
 <root>
   <!-- my comment -->
-  <element attribute="value" />
-  <element attribute='value'></element>
+  <self-closing attribute="value with double quotes" />
+  <non-self-closing attribute='value with single quotes'></non-self-closing>
+  <element-with-cdata><![CDATA[<html>]]></element-with-cdata>
 </root>
 ```
 
@@ -39,9 +40,11 @@ new XmlDocument([
     new XmlText('\n  '),
     new XmlComment(' my comment '),
     new XmlText('\n  '),
-    new XmlElement('element', [new XmlAttribute('attribute', 'value')], [], ' ', true),
+    new XmlElement('self-closing', [new XmlAttribute('attribute', 'value with double quotes')], [], ' ', true),
     new XmlText('\n  '),
-    new XmlElement('element', [new XmlAttribute('attribute', 'value', ' ', '', '', "'")], [], '', false),
+    new XmlElement('non-self-closing', [new XmlAttribute('attribute', 'value with single quotes', ' ', '', '', "'")], [], '', false),
+    new XmlText('\n  '),
+    new XmlElement('element-with-cdata', [], [new XmlCData('<html>')]),
     new XmlText('\n')
   ])
 ]);
diff --git a/package.json b/package.json
@@ -19,7 +19,7 @@
     "test": "bun test --coverage",
     "format": "prettier --write .",
     "typecheck": "tsc --noEmit",
-    "prepack": "bun run build:types && bun run build:esm && bun run build:cjs",
+    "prepack": "bun run build:types && bun run build:esm && bun run build:cjs"
   },
   "keywords": [
     "XML",
diff --git a/xmlParser.spec.ts b/xmlParser.spec.ts
@@ -6,6 +6,7 @@ import { XmlAttribute } from './model/xmlAttribute';
 import { XmlElement } from './model/xmlElement';
 import { XmlParser } from './xmlParser';
 import { XmlDocument } from './model/xmlDocument';
+import { XmlCData } from './model/xmlCData';
 
 describe('XmlParser', () => {
   describe('parse', () => {
@@ -28,8 +29,9 @@ describe('XmlParser', () => {
       const xml = `<?xml version="1.0" encoding="UTF-8"?>
 <root>
   <!-- my comment -->
-  <element attribute="value" />
-  <element attribute='value'></element>
+  <self-closing attribute="value with double quotes" />
+  <non-self-closing attribute='value with single quotes'></non-self-closing>
+  <element-with-cdata><![CDATA[<html>]]></element-with-cdata>
 </root>`;
       const doc = XmlParser.parse(xml);
       expect(doc).toEqual(new XmlDocument([
@@ -39,9 +41,11 @@ describe('XmlParser', () => {
           new XmlText('\n  '),
           new XmlComment(' my comment '),
           new XmlText('\n  '),
-          new XmlElement('element', [new XmlAttribute('attribute', 'value')], [], ' ', true),
+          new XmlElement('self-closing', [new XmlAttribute('attribute', 'value with double quotes')], [], ' ', true),
           new XmlText('\n  '),
-          new XmlElement('element', [new XmlAttribute('attribute', 'value', ' ', '', '', "'")], [], '', false),
+          new XmlElement('non-self-closing', [new XmlAttribute('attribute', 'value with single quotes', ' ', '', '', "'")], [], '', false),
+          new XmlText('\n  '),
+          new XmlElement('element-with-cdata', [], [new XmlCData('<html>')]),
           new XmlText('\n')
         ])
       ]));
diff --git a/xmlParser.ts b/xmlParser.ts
@@ -267,18 +267,6 @@ export class XmlParser {
     return this.input.substring(start, this.pos);
   }
 
-  // Reads until the given pattern is matched.
-  readUntil(pattern: RegExp): string {
-    const start = this.pos;
-    while (
-      this.pos < this.input.length &&
-      !pattern.test(this.input[this.pos])
-    ) {
-      this.pos++;
-    }
-    return this.input.substring(start, this.pos);
-  }
-
   // Helper: check if input at current position starts with any string in the list.
   startsWithAny(strings: string[]): boolean {
     for (const s of strings) {
