.github/workflows/main.yml

@@ -7,15 +7,15 @@ jobs:
     name: ${{matrix.node}}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: dcodeIO/setup-node-nvm@master
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{matrix.node}}
       - run: npm install
       - run: npm test
-      - uses: codecov/codecov-action@v1
+      - uses: codecov/codecov-action@v3
     strategy:
       matrix:
         node:
-          - lts/fermium
+          - lts/gallium
           - node

.gitignore

@@ -1,5 +1,5 @@
 .DS_Store
-index.d.ts
+lib/index.d.ts
 test.d.ts
 *.log
 coverage/

.npmrc

@@ -1 +1,2 @@
 package-lock=false
+ignore-scripts=true

complex-types.d.ts

@@ -1,54 +1,2 @@
-import type {Node, Parent} from 'unist'
-import type {Test} from 'unist-util-is'
-import type {
-  VisitorResult,
-  Matches,
-  InclusiveDescendant
-} from 'unist-util-visit-parents/complex-types.js'
-
-/**
- * Called when a node (matching test, if given) is found.
- * Visitors are free to transform node.
- * They can also transform the parent of node (the last of ancestors).
- * Replacing node itself, if `SKIP` is not returned, still causes its descendants to be visited.
- * If adding or removing previous siblings (or next siblings, in case of reverse) of node,
- * visitor should return a new index (number) to specify the sibling to traverse after node is traversed.
- * Adding or removing next siblings of node (or previous siblings, in case of reverse)
- * is handled as expected without needing to return a new index.
- * Removing the children property of an ancestor still results in them being traversed.
- */
-export type Visitor<
-  Visited extends Node = Node,
-  Ancestor extends Parent = Parent
-> = (
-  node: Visited,
-  index: Visited extends Node ? number | null : never,
-  parent: Ancestor extends Node ? Ancestor | null : Ancestor
-) => VisitorResult
-
-type ParentsOf<
-  Ancestor extends Node,
-  Child extends Node
-> = Ancestor extends Parent
-  ? Child extends Ancestor['children'][number]
-    ? Ancestor
-    : never
-  : never
-
-type BuildVisitorFromMatch<
-  Visited extends Node,
-  Ancestor extends Parent
-> = Visitor<Visited, ParentsOf<Ancestor, Visited>>
-
-type BuildVisitorFromDescendants<
-  Descendant extends Node,
-  Check extends Test
-> = BuildVisitorFromMatch<
-  Matches<Descendant, Check>,
-  Extract<Descendant, Parent>
->
-
-export type BuildVisitor<
-  Tree extends Node = Node,
-  Check extends Test = string
-> = BuildVisitorFromDescendants<InclusiveDescendant<Tree>, Check>
+// To do: next major: remove this file.
+export type {Visitor, BuildVisitor} from './index.js'

index.d.ts

@@ -0,0 +1,9 @@
+export type {Test} from 'unist-util-is'
+export type {
+  Action,
+  ActionTuple,
+  Index,
+  VisitorResult
+} from 'unist-util-visit-parents'
+export type {Visitor, BuildVisitor} from './lib/index.js'
+export {CONTINUE, EXIT, SKIP, visit} from './lib/index.js'

index.js

@@ -1,61 +1,2 @@
-/**
- * @typedef {import('unist').Node} Node
- * @typedef {import('unist').Parent} Parent
- * @typedef {import('unist-util-is').Test} Test
- * @typedef {import('unist-util-visit-parents').VisitorResult} VisitorResult
- * @typedef {import('./complex-types.js').Visitor} Visitor
- */
-
-import {visitParents} from 'unist-util-visit-parents'
-
-/**
- * Visit children of tree which pass test.
- *
- * @param tree
- *   Tree to walk
- * @param [test]
- *   `unist-util-is`-compatible test
- * @param visitor
- *   Function called for nodes that pass `test`.
- * @param reverse
- *   Traverse in reverse preorder (NRL) instead of preorder (NLR) (default).
- */
-export const visit =
-  /**
-   * @type {(
-   *   (<Tree extends Node, Check extends Test>(tree: Tree, test: Check, visitor: import('./complex-types.js').BuildVisitor<Tree, Check>, reverse?: boolean) => void) &
-   *   (<Tree extends Node>(tree: Tree, visitor: import('./complex-types.js').BuildVisitor<Tree>, reverse?: boolean) => void)
-   * )}
-   */
-  (
-    /**
-     * @param {Node} tree
-     * @param {Test} test
-     * @param {import('./complex-types.js').Visitor} visitor
-     * @param {boolean} [reverse]
-     */
-    function (tree, test, visitor, reverse) {
-      if (typeof test === 'function' && typeof visitor !== 'function') {
-        reverse = visitor
-        visitor = test
-        test = null
-      }
-
-      visitParents(tree, test, overload, reverse)
-
-      /**
-       * @param {Node} node
-       * @param {Array<Parent>} parents
-       */
-      function overload(node, parents) {
-        const parent = parents[parents.length - 1]
-        return visitor(
-          node,
-          parent ? parent.children.indexOf(node) : null,
-          parent
-        )
-      }
-    }
-  )
-
-export {CONTINUE, EXIT, SKIP} from 'unist-util-visit-parents'
+// Note: types exported from `index.d.ts`
+export {CONTINUE, EXIT, SKIP, visit} from './lib/index.js'

index.test-d.ts

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-empty-function */
 
 import {expectError, expectType} from 'tsd'
-import {Node, Parent, Literal} from 'unist'
+import type {Node, Parent, Literal} from 'unist'
 import {is} from 'unist-util-is'
 import {visit, SKIP, EXIT, CONTINUE} from './index.js'
 
@@ -31,6 +31,7 @@ const complexTree: Root = {
   ]
 }
 
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 interface Element extends Parent {
   type: 'element'
   tagName: string
@@ -41,36 +42,42 @@ interface Element extends Parent {
 
 type Content = Flow | Phrasing
 
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 interface Root extends Parent {
   type: 'root'
   children: Array<Flow>
 }
 
 type Flow = Blockquote | Heading | Paragraph
 
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 interface Blockquote extends Parent {
   type: 'blockquote'
   children: Array<Flow>
 }
 
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 interface Heading extends Parent {
   type: 'heading'
   depth: number
   children: Array<Phrasing>
 }
 
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 interface Paragraph extends Parent {
   type: 'paragraph'
   children: Array<Phrasing>
 }
 
 type Phrasing = Text | Emphasis
 
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 interface Emphasis extends Parent {
   type: 'emphasis'
   children: Array<Phrasing>
 }
 
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 interface Text extends Literal {
   type: 'text'
   value: string