Change to remove force shortcut

Author: wooorm

index.test-d.ts

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

lib/index.js

@@ -20,16 +20,15 @@ import {visit} from 'unist-util-visit'
  *   Node type.
  * @param {Tree} tree
  *   Tree to clean.
- * @param {Options | boolean | null | undefined} [options={force: false}]
+ * @param {Options | null | undefined} [options={force: false}]
  *   Configuration (default: `{force: false}`).
  * @returns {Tree}
  *   The given, modified, `tree`.
  */
 // To do: next major: return `undefined`.
-// To do: remove `force` shortcut, replace with options.
 export function removePosition(tree, options) {
-  const force =
-    typeof options === 'boolean' ? options : options ? options.force : false
+  const config = options || {}
+  const force = config.force || false
 
   visit(tree, remove)
 

readme.md

@@ -17,7 +17,7 @@
 *   [Install](#install)
 *   [Use](#use)
 *   [API](#api)
-    *   [`removePosition(node[, force|options])`](#removepositionnode-forceoptions)
+    *   [`removePosition(node[, options])`](#removepositionnode-options)
     *   [`Options`](#options)
 *   [Types](#types)
 *   [Compatibility](#compatibility)
@@ -110,16 +110,14 @@ Yields:
 This package exports the identifier [`removePosition`][removeposition].
 There is no default export.
 
-### `removePosition(node[, force|options])`
+### `removePosition(node[, options])`
 
 Remove the `position` field from a tree.
 
 ###### Parameters
 
 *   `node` ([`Node`][node])
     — tree to clean
-*   `force` (`boolean`)
-    — equivalent to `{force: boolean}`
 *   `options` ([`Options`][options], optional)
     — configuration
 
@@ -224,6 +222,6 @@ abide by its terms.
 
 [unist-util-stringify-position]: https://github.com/syntax-tree/unist-util-stringify-position
 
-[removeposition]: #removepositionnode-forceoptions
+[removeposition]: #removepositionnode-options
 
 [options]: #options

test.js

@@ -32,10 +32,9 @@ test('removePosition', async function (t) {
 
   await t.test('should work by force', async function () {
     assert.deepEqual(
-      removePosition(
-        fromMarkdown('Some **strong**, _emphasis_, and `code`.'),
-        true
-      ),
+      removePosition(fromMarkdown('Some **strong**, _emphasis_, and `code`.'), {
+        force: true
+      }),
       u('root', [
         u('paragraph', [
           u('text', 'Some '),