@lowlighter/xml 5.4.11 → 5.4.12

package/deno.jsonc

@@ -1,7 +1,7 @@
 {
   "icon": "📃",
   "name": "@libs/xml",
-  "version": "5.4.11",
+  "version": "5.4.12",
   "description": "XML parser/stringifier with no dependencies.",
   "keywords": [
     "xml",
@@ -35,7 +35,7 @@
   "imports": {
     "@std/fs/expand-glob": "jsr:@std/fs@0.229.3/expand-glob",
     "@std/fs/exists": "jsr:@std/fs@0.229.3/exists",
-    "@std/path/from-file-url": "jsr:@std/path@0.225.2/from-file-url",
+    "@std/path/from-file-url": "jsr:@std/path@1/from-file-url",
     "@libs/typing": "jsr:@libs/typing@2",
     "@libs/testing": "jsr:@libs/testing@2"
   },

package/deno.lock

@@ -17,6 +17,7 @@
       "jsr:@std/internal@^1.0.0": "jsr:@std/internal@1.0.1",
       "jsr:@std/io@^0.224.1": "jsr:@std/io@0.224.3",
       "jsr:@std/path@0.225.2": "jsr:@std/path@0.225.2",
+      "jsr:@std/path@1": "jsr:@std/path@1.0.0",
       "jsr:@std/streams@0.224.5": "jsr:@std/streams@0.224.5"
     },
     "jsr": {
@@ -89,6 +90,9 @@
       "@std/path@0.225.2": {
         "integrity": "0f2db41d36b50ef048dcb0399aac720a5348638dd3cb5bf80685bf2a745aa506"
       },
+      "@std/path@1.0.0": {
+        "integrity": "77fcb858b6e38777d1154df0f02245ba0b07e2c40ca3c0eec57c9233188c2d21"
+      },
       "@std/streams@0.224.5": {
         "integrity": "bcde7818dd5460d474cdbd674b15f6638b9cd73cd64e52bd852fba2bd4d8ec91",
         "dependencies": [
@@ -104,7 +108,7 @@
       "jsr:@libs/testing@2",
       "jsr:@libs/typing@2",
       "jsr:@std/fs@0.229.3",
-      "jsr:@std/path@0.225.2"
+      "jsr:@std/path@1"
     ]
   }
 }

package/mod_test.ts

@@ -0,0 +1 @@
+import "./mod.ts"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lowlighter/xml",
-  "version": "5.4.11",
+  "version": "5.4.12",
   "type": "module",
   "scripts": {},
   "dependencies": {},

package/parse.ts

@@ -2,10 +2,8 @@
 import { initSync, JsReader, source, Token, tokenize } from "./wasm_xml_parser/wasm_xml_parser.js"
 import type { record, rw } from "@libs/typing"
 import type { Nullable, ReaderSync, xml_document, xml_node, xml_text } from "./_types.ts"
-initSync(source())
-
-// Re-exports
 export type { Nullable, ReaderSync, xml_document, xml_node, xml_text }
+initSync(source())
 
 /** XML parser options. */
 export type options = {
@@ -113,6 +111,8 @@ export type options = {
  * using file = await Deno.open("bench/assets/small.xml")
  * console.log(parse(file))
  * ```
+ *
+ * @module
  */
 export function parse(content: string | ReaderSync, options?: options): xml_document {
   const xml = xml_node("~xml") as xml_document

package/stringify.ts

@@ -1,8 +1,6 @@
 // Imports
 import type { Nullable, record, rw } from "@libs/typing"
 import type { stringifyable, xml_document, xml_node, xml_text } from "./_types.ts"
-
-// Re-exports
 export type { Nullable, stringifyable, xml_document, xml_node, xml_text }
 
 /** XML stringifier options. */
@@ -64,6 +62,8 @@ const internal = Symbol("internal")
  *   }
  * }))
  * ```
+ *
+ * @module
  */
 export function stringify(document: stringifyable, options?: options): string {
   options ??= {}
@@ -100,7 +100,16 @@ export function stringify(document: stringifyable, options?: options): string {
   return text.trim()
 }
 
-/** Helper to create a CDATA node. */
+/**
+ * Helper to create a CDATA node.
+ *
+ * @example
+ * ```ts
+ * import { stringify, cdata } from "./stringify.ts"
+ * stringify({ string: cdata(`hello <world>`) })
+ * // <string><![CDATA[hello <world>]]></string>
+ * ```
+ */
 export function cdata(text: string): Omit<xml_text, "~parent"> {
   return {
     "~name": "~cdata",
@@ -108,7 +117,16 @@ export function cdata(text: string): Omit<xml_text, "~parent"> {
   }
 }
 
-/** Helper to create a comment node. */
+/**
+ * Helper to create a comment node.
+ *
+ * @example
+ * ```ts
+ * import { stringify, comment } from "./stringify.ts"
+ * stringify({ string: comment(`hello world`) })
+ * // <string><!--hello world--></string>
+ * ```
+ */
 export function comment(text: string): Omit<xml_text, "~parent"> {
   return {
     "~name": "~comment",