Add support for options

Author: wooorm

index.js

@@ -1,4 +1,5 @@
 /**
+ * @typedef {import('./lib/index.js').Options} Options
  * @typedef {import('./lib/index.js').Space} Space
  */
 

lib/index.js

@@ -21,7 +21,16 @@
 
 /**
  * @typedef {Content | Root} Node
- * @typedef {'html'|'svg'} Space
+ * @typedef {'html' | 'svg'} Space
+ *
+ * @typedef Options
+ *   Configuration.
+ * @property {Space | null | undefined} [space='html']
+ *   Which space the document is in.
+ *
+ *   When an `<svg>` element is found in the HTML space, this package already
+ *   automatically switches to and from the SVG space when entering and exiting
+ *   it.
  */
 
 import {stringify as commas} from 'comma-separated-tokens'
@@ -40,12 +49,13 @@ const one = zwitch('type', {handlers: {root, element, text, comment, doctype}})
  *
  * @param {Node} tree
  *   Tree to transform.
- * @param {Space | null | undefined} [space='html']
+ * @param {Options | Space | null | undefined} [options]
  *   Current space.
  * @returns {P5Node}
  *   `parse5` node.
  */
-export function toParse5(tree, space) {
+export function toParse5(tree, options) {
+  const space = options && typeof options === 'object' ? options.space : options
   return one(tree, space === 'svg' ? svg : html)
 }
 

test/index.js

@@ -4,6 +4,29 @@ import stringify from 'json-stringify-safe'
 import {parse, parseFragment} from 'parse5'
 import {toParse5} from '../index.js'
 
+test('core', () => {
+  assert.deepEqual(
+    json(
+      toParse5({
+        type: 'root',
+        children: [
+          {type: 'doctype', name: 'html'},
+          {
+            type: 'element',
+            tagName: 'html',
+            children: [
+              {type: 'element', tagName: 'head', children: []},
+              {type: 'element', tagName: 'body', children: []}
+            ]
+          }
+        ]
+      })
+    ),
+    json(parse('<!doctypehtml>')),
+    'should transform a root (no-quirks)'
+  )
+})
+
 test('root', () => {
   assert.deepEqual(
     json(
@@ -356,7 +379,31 @@ test('svg', () => {
       )
     ),
     json(expectedSvgChild),
-    'should transform SVG'
+    'should transform SVG (given a space)'
+  )
+
+  const expectedSvgOptions = parseFragment(
+    '<svg><circle cx="60"  cy="60" r="50" fill="red"/></svg>'
+  ).childNodes[0]
+  assert(expectedSvgOptions && 'childNodes' in expectedSvg)
+  const expectedSvgOptionsChild = expectedSvg.childNodes[0]
+  // @ts-expect-error: p5 wants `null`.
+  expectedSvgChild.parentNode = undefined
+
+  assert.deepEqual(
+    json(
+      toParse5(
+        {
+          type: 'element',
+          tagName: 'circle',
+          properties: {cx: '60', cy: '60', r: '50', fill: 'red'},
+          children: []
+        },
+        {space: 'svg'}
+      )
+    ),
+    json(expectedSvgOptionsChild),
+    'should transform SVG (given options)'
   )
 })