Change to yield undefined

Author: wooorm

index.test-d.ts

@@ -4,6 +4,8 @@ import {removePosition} from './index.js'
 
 const tree: Root = {type: 'root', children: []}
 
-expectType<Root>(removePosition(tree))
-expectType<Root>(removePosition(tree, {force: false}))
-expectType<Root>(removePosition(tree, {force: true}))
+expectType<undefined>(removePosition(tree))
+
+removePosition(tree, {force: false})
+
+removePosition(tree, {force: true})

lib/index.js

@@ -16,24 +16,19 @@ import {visit} from 'unist-util-visit'
 /**
  * Remove the `position` field from a tree.
  *
- * @template {Node} Tree
- *   Node type.
- * @param {Tree} tree
+ * @param {Node} tree
  *   Tree to clean.
  * @param {Options | null | undefined} [options={force: false}]
  *   Configuration (default: `{force: false}`).
- * @returns {Tree}
- *   The given, modified, `tree`.
+ * @returns {undefined}
+ *   Nothing.
  */
-// To do: next major: return `undefined`.
 export function removePosition(tree, options) {
   const config = options || {}
   const force = config.force || false
 
   visit(tree, remove)
 
-  return tree
-
   /**
    * @param {Node} node
    */

readme.md

@@ -123,7 +123,7 @@ Remove the `position` field from a tree.
 
 ###### Returns
 
-The given, modified, `tree` ([`Node`][node]).
+Nothing (`undefined`).
 
 ### `Options`
 

test.js

@@ -14,8 +14,11 @@ test('removePosition', async function (t) {
   await t.test('should work softly', async function () {
     const empty = {position: undefined}
 
+    const root = fromMarkdown('Some **strong**, _emphasis_, and `code`.')
+    removePosition(root)
+
     assert.deepEqual(
-      removePosition(fromMarkdown('Some **strong**, _emphasis_, and `code`.')),
+      root,
       u('root', empty, [
         u('paragraph', empty, [
           u('text', empty, 'Some '),
@@ -31,10 +34,12 @@ test('removePosition', async function (t) {
   })
 
   await t.test('should work by force', async function () {
+    const root = fromMarkdown('Some **strong**, _emphasis_, and `code`.')
+
+    removePosition(root, {force: true})
+
     assert.deepEqual(
-      removePosition(fromMarkdown('Some **strong**, _emphasis_, and `code`.'), {
-        force: true
-      }),
+      root,
       u('root', [
         u('paragraph', [
           u('text', 'Some '),
@@ -50,9 +55,9 @@ test('removePosition', async function (t) {
   })
 
   await t.test('should support options', async function () {
-    assert.deepEqual(
-      removePosition(fromMarkdown('x'), {force: true}),
-      u('root', [u('paragraph', [u('text', 'x')])])
-    )
+    const root = fromMarkdown('x')
+    removePosition(root, {force: true})
+
+    assert.deepEqual(root, u('root', [u('paragraph', [u('text', 'x')])]))
   })
 })