@ooxml-tools/xml 0.1.0 → 0.2.0

package/README.md

@@ -42,7 +42,8 @@ safeXml`<foo>hello</bar>`
 Substitution of arrays "just works" so you can map values in the tagged template literals  
  
 ```ts
-const outXml = safeXml`<test>${[1,2,3].map(n => safeXml`<name>item ${1}<name>`)}</test>`
+const items = [1,2,3].map(n => safeXml`<name>item ${1}</name>`);
+const outXml = safeXml`<test>${items}</test>`
 assert.equal(outXml, `<test><name>item 1</name><name>item 2</name><name>item 3</name></test>`);
 ```
 
@@ -118,6 +119,25 @@ But `<name><![CDATA[one < two]]><name>` is ugly and hard to read, so instead
 safeXml`<name>${cdata("one < two")}</name>`
 ```
 
+### `format`
+Format XML in a consistent way, useful for logging and snapshot testing
+
+```ts
+format(`
+   <test> one
+      </test>
+`) /* =>
+ * <test>
+ *   one
+ * </test>
+ */
+```
+
+## CI
+
+[![codecov](https://codecov.io/gh/ooxml-tools/xml/graph/badge.svg?token=N82AKMVJM7)](https://codecov.io/gh/ooxml-tools/xml)
+
+
 ## License
 
 MIT

package/dist/npm/index.js

@@ -98,4 +98,18 @@ function collapseFragments(root) {
     return out;
 }
 
-export { asXmlElement, cdata, collapseFragments, compact, createFragment, safeXml };
+function format(input, { spaces = 2 } = {}) {
+    const elementJson = xml2js(input, {
+        compact: false,
+        captureSpacesBetweenElements: false,
+    });
+    return js2xml(elementJson, {
+        spaces: spaces,
+        compact: false,
+        indentText: true,
+        fullTagEmptyElement: true,
+        indentAttributes: true,
+    });
+}
+
+export { asXmlElement, cdata, collapseFragments, compact, createFragment, format, safeXml };

package/dist/npm/types.d.ts

@@ -16,4 +16,10 @@ declare function compact(xml: string): string;
 declare function createFragment(elements: Element[]): Element;
 declare function collapseFragments(root: string | Element): Element;
 
-export { asXmlElement, cdata, collapseFragments, compact, createFragment, safeXml };
+type FormatOptions = {
+    spaces?: number;
+};
+declare function format(input: string, { spaces }?: FormatOptions): string;
+
+export { asXmlElement, cdata, collapseFragments, compact, createFragment, format, safeXml };
+export type { FormatOptions };

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@ooxml-tools/xml",
   "description": "Some XML helpers to help with OOXML development",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "MIT",
   "main": "./dist/npm/index.js",
   "types": "./dist/npm/types.d.ts",
   "type": "module",
   "scripts": {
     "lint": "npx prettier . --check",
-    "test": "vitest",
+    "test": "vitest run --coverage",
+    "test:ci": "vitest run --coverage --reporter=junit --outputFile=test-report.junit.xml",
     "lint:format": "npx prettier . --write",
     "build": "rollup -c rollup.config.ts --configPlugin typescript"
   },
@@ -22,11 +23,13 @@
     "./README.md"
   ],
   "devDependencies": {
+    "@codecov/rollup-plugin": "^1.9.1",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-typescript": "^12.1.2",
     "@rollup/plugin-virtual": "^3.0.2",
     "@tsconfig/node22": "^22.0.0",
     "@types/yargs": "^17.0.32",
+    "@vitest/coverage-v8": "^3.2.4",
     "prettier": "^3.4.2",
     "rollup": "^4.18.1",
     "rollup-plugin-copy": "^3.5.0",
@@ -37,7 +40,7 @@
     "tslib": "^2.6.3",
     "tsx": "^4.17.0",
     "typescript": "^5.5.4",
-    "vitest": "^2.1.6"
+    "vitest": "^3.2.4"
   },
   "engines": {
     "node": ">=20.x"