feat: add path.remove

Author: gregberge

packages/h2x-traverse/src/NodePath.js

@@ -56,15 +56,21 @@ class NodePath {
     this.context.visit(this.container, this.key)
   }
 
+  remove() {
+    this.shouldStop = true
+    this.node = null
+    this.container[this.key] = null
+  }
+
   _call(fns) {
     if (!fns) return false
     if (!Array.isArray(fns)) fns = [fns]
 
     for (const fn of fns) {
       if (!fn) continue
 
-      // Node has been removed, it will have been requeued
       const node = this.node
+      if (!node) return true
 
       const ret = fn(this, this.state)
       if (ret)

packages/h2x-traverse/src/TraversalContext.js

@@ -19,10 +19,12 @@ class TraversalContext {
   visitMultiple(container, parent, listKey) {
     if (container.length === 0) return false
     let shouldStop = false
-    for (let key = 0; key < container.length; key += 1) {
+
+    Array.from(container).forEach((value, key) => {
+      if (!value) return
       const nodePath = this.create(parent, container, key, listKey)
       if (nodePath && nodePath.visit()) shouldStop = true
-    }
+    })
 
     return shouldStop
   }

packages/h2x-traverse/src/index.js

@@ -3,6 +3,7 @@ import { getNodeVisitorKeys } from 'h2x-types'
 import TraversalContext from './TraversalContext'
 
 function traverse(ast, opts = {}, state = {}) {
+  if (!ast) return
   const keys = getNodeVisitorKeys(ast)
   if (!keys) return
 

packages/h2x-traverse/src/index.test.js

@@ -122,4 +122,28 @@ describe('traverse', () => {
     expect(enter.mock.calls[0][0].type).toBe('HTMLElement')
     expect(enter.mock.calls[1][0].type).toBe('HTMLElement')
   })
+
+  it('should be possible to remove', () => {
+    const enter = jest.fn(path => {
+      if (path.node.tagName === 'DIV') {
+        path.remove()
+      }
+    })
+
+    const ast = parse(`<header><div></div><span></span></header>`)
+
+    traverse(ast, {
+      enter,
+    })
+
+    expect(enter).toHaveBeenCalledTimes(3)
+    expect(enter.mock.calls[0][0].type).toBe('HTMLElement')
+    expect(enter.mock.calls[1][0].type).toBe('HTMLElement')
+
+    traverse(ast, {
+      enter,
+    })
+
+    expect(enter).toHaveBeenCalledTimes(5)
+  })
 })