mrzmmr/unist-util-find-all-between

unist-util-find-all-between

unist utility to find nodes between two nodes.

Install

npm i -S unist-util-find-all-between

Usage

const between = require('unist-util-find-all-between')
const u = require('unist-builder')

const parent = u('tree', [
  u('leaf', 'leaf 1'),
  u('node', [u('leaf', 'leaf 2'), u('leaf', 'leaf 3')]),
  u('leaf', 'leaf 4'),
  u('node', [u('leaf', 'leaf 5')]),
  u('leaf', 'leaf 6'),
  u('void'),
  u('leaf', 'leaf 7')
])

const result = between(parent, 0, 4, 'leaf')

console.log(result)

Yields:

[ { type: 'leaf', value: 'leaf 4' } ]

You can also pass a node in as start and/or end. For example given the tree above,

// ...

const start = {
  type: 'leaf',
  value: 'leaf 4'
}

const end = {
  type: 'leaf',
  value: 'leaf 6'
}

const result = between(parent, start, end, 'node')

console.dir(result, {depth: null})

Yields:

[ { type: 'node',
    children: [ { type: 'leaf', value: 'leaf 5' } ] } ]

API

between(parent, start, end[, test])

Find all child nodes of parent, that pass test between but not including start and end.

parent

Type: Node

Parent node to search through.

start

Type: Node | index

Child of parent node. Can be an actual node or the index of a child node. If a node is given, unist-util-find is used to find the node.

end

Type: Node | index

Child of parent node. Can be an actual node or the index of a child node. If a node is given, unist-util-find is used to find the node.

test?

Type: Function | String | Object | Array

Test to find nodes. Uses unist-util-is to check.

Related

• unist-util-find-all-before
• unist-util-find-all-after
• unist-util-find
• unist-util-is

Contribute

PRs accepted and greatly appreciated.

License

MIT © Paul Zimmer

unist-util-find-all-between's Issues

fix the "Error [ERR_REQUIRE_ESM]: require() of ES Module not supported"

Can you support also ESM with "type": "module", in package.json.

The main issue is unist-util-find actually, and it needs to use import instead of require() in index.js file

import {is} from 'unist-util-is';
import find from 'unist-util-find';

Can you upgrade the dependencies also?

Lack of the upgrade causes the error "Error [ERR_REQUIRE_ESM]: require() of ES Module not supported" in nextjs application.

from

  "dependencies": {
    "unist-util-find": "^1.0.1",
    "unist-util-is": "^4.0.2"
  },

to

  "dependencies": {
    "unist-util-find": "^1.0.3",
    "unist-util-is": "^5.2.1"
  },

Refractor

Hey, sorry for opening an issue for a question.
I got a tree returned by: https://github.com/wooorm/refractor, but it doesn't have a root element.

How could I use this package with that kind of tree?

Last node is missing

findAllBetween does not include last node which I guess is unexpected and not mentioned in documentation.

I think even the example is misleading because it misses "." at the end.

It is also inconvenient when used with node rather than index because you have to switch to index syntax anyway even when you already have second node.

Add types

I would be willing to add types for this module.
In order to use dtslint I would have to create a local bundle.

My idea is to align the build pipeline with syntax-tree/unist-util-find-all-after.

With this the local module can be used to test the types correctly.