Remove support for passing file directly

syntax-tree · Aug 5, 2023 · 81cde21 · 81cde21
1 parent ca404c7
commit 81cde21
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 165 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -77,29 +77,17 @@ const proto = Object.prototype
  *
  * @param {P5Node} tree
  *   `parse5` tree to transform.
- * @param {Options | VFile | null | undefined} [options]
+ * @param {Options | null | undefined} [options]
  *   Configuration (optional).
  * @returns {Nodes}
  *   hast tree.
  */
 export function fromParse5(tree, options) {
-  const options_ = options || {}
-  /** @type {Options} */
-  let settings
-  /** @type {VFile | undefined} */
-  let file
-
-  if (isFile(options_)) {
-    file = options_
-    settings = {}
-  } else {
-    file = options_.file || undefined
-    settings = options_
-  }
+  const settings = options || {}
 
   return one(
     {
-      file,
+      file: settings.file || undefined,
       location: false,
       schema: settings.space === 'svg' ? svg : html,
       verbose: settings.verbose
@@ -381,15 +369,3 @@ function position(loc) {
 function point(point) {
   return point.line && point.column ? point : undefined
 }
-
-/**
- * Check if something is a file.
- *
- * @param {VFile | Options} value
- *   File or options.
- * @returns {value is VFile}
- *   Whether `value` is a file.
- */
-function isFile(value) {
-  return 'messages' in value
-}
diff --git a/readme.md b/readme.md
@@ -17,7 +17,7 @@
 *   [Install](#install)
 *   [Use](#use)
 *   [API](#api)
-    *   [`fromParse5(tree[, file|options])`](#fromparse5tree-fileoptions)
+    *   [`fromParse5(tree[, options])`](#fromparse5tree-options)
     *   [`Options`](#options)
     *   [`Space`](#space-1)
 *   [Types](#types)
@@ -84,7 +84,7 @@ import {fromParse5} from 'hast-util-from-parse5'
 
 const file = await read('example.html')
 const p5ast = parse(String(file), {sourceCodeLocationInfo: true})
-const hast = fromParse5(p5ast, file)
+const hast = fromParse5(p5ast, {file})
 
 console.log(inspect(hast))
 ```
@@ -118,16 +118,14 @@ root[2] (1:1-2:1, 0-70)
 This package exports the identifier [`fromParse5`][fromparse5].
 There is no default export.
 
-### `fromParse5(tree[, file|options])`
+### `fromParse5(tree[, options])`
 
 Transform a `parse5` AST to hast.
 
 ###### Parameters
 
 *   `tree` ([`Parse5Node`][parse5-node])
     — `parse5` tree to transform
-*   `file` ([`VFile`][vfile], optional)
-    — corresponding file (treated as `{file: file}`)
 *   `options` ([`Options`][options], optional)
     — configuration
 
@@ -326,7 +324,7 @@ abide by its terms.
 
 [hast-node]: https://github.com/syntax-tree/hast#nodes
 
-[fromparse5]: #fromparse5tree-fileoptions
+[fromparse5]: #fromparse5tree-options
 
 [options]: #options
 

diff --git a/test/index.js b/test/index.js
@@ -93,136 +93,6 @@ test('fromParse5', async function (t) {
     })
   })
 
-  await t.test('should accept a file as options', async function () {
-    assert.deepEqual(
-      fromParse5(parse(String(file), {sourceCodeLocationInfo: true}), file),
-      {
-        type: 'root',
-        children: [
-          {
-            type: 'element',
-            tagName: 'html',
-            properties: {},
-            children: [
-              {
-                type: 'element',
-                tagName: 'head',
-                properties: {},
-                children: [
-                  {
-                    type: 'element',
-                    tagName: 'title',
-                    properties: {},
-                    children: [
-                      {
-                        type: 'text',
-                        value: 'Hello!',
-                        position: {
-                          start: {line: 1, column: 8, offset: 7},
-                          end: {line: 1, column: 14, offset: 13}
-                        }
-                      }
-                    ],
-                    position: {
-                      start: {line: 1, column: 1, offset: 0},
-                      end: {line: 1, column: 22, offset: 21}
-                    }
-                  }
-                ]
-              },
-              {
-                type: 'element',
-                tagName: 'body',
-                properties: {},
-                children: [
-                  {
-                    type: 'element',
-                    tagName: 'h1',
-                    properties: {},
-                    children: [
-                      {
-                        type: 'text',
-                        value: 'World!',
-                        position: {
-                          start: {line: 1, column: 26, offset: 25},
-                          end: {line: 1, column: 32, offset: 31}
-                        }
-                      }
-                    ],
-                    position: {
-                      start: {line: 1, column: 22, offset: 21},
-                      end: {line: 1, column: 32, offset: 31}
-                    }
-                  }
-                ]
-              }
-            ]
-          }
-        ],
-        data: {quirksMode: true},
-        position: {
-          start: {line: 1, column: 1, offset: 0},
-          end: {line: 1, column: 32, offset: 31}
-        }
-      }
-    )
-  })
-
-  await t.test(
-    'should accept a file as options (without location info)',
-    async function () {
-      assert.deepEqual(fromParse5(parse(String(file)), file), {
-        type: 'root',
-        children: [
-          {
-            type: 'element',
-            tagName: 'html',
-            properties: {},
-            children: [
-              {
-                type: 'element',
-                tagName: 'head',
-                properties: {},
-                children: [
-                  {
-                    type: 'element',
-                    tagName: 'title',
-                    properties: {},
-                    children: [
-                      {
-                        type: 'text',
-                        value: 'Hello!'
-                      }
-                    ]
-                  }
-                ]
-              },
-              {
-                type: 'element',
-                tagName: 'body',
-                properties: {},
-                children: [
-                  {
-                    type: 'element',
-                    tagName: 'h1',
-                    properties: {},
-                    children: [
-                      {
-                        type: 'text',
-                        value: 'World!'
-                      }
-                    ]
-                  }
-                ]
-              }
-            ]
-          }
-        ],
-        data: {quirksMode: true}
-      })
-    }
-  )
-
   await t.test('should support synthetic locations', async function () {
     assert.deepEqual(
       fromParse5(
@@ -246,7 +116,7 @@ test('fromParse5', async function (t) {
             startOffset: 0
           }
         },
-        file
+        {file}
       ),
       {
         type: 'element',
@@ -295,7 +165,7 @@ test('fromParse5', async function (t) {
               startOffset: 0
             }
           },
-          file
+          {file}
         ),
         {
           type: 'element',