Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/f1lt3r/balanced-pairs
🏄 get blocks of balanced pairs, eg: {}, <a></a> or code fences ```
https://github.com/f1lt3r/balanced-pairs
balance blocks brace code-fence delimiters even match pairs parse tags uneven
Last synced: about 2 months ago
JSON representation
🏄 get blocks of balanced pairs, eg: {}, <a></a> or code fences ```
- Host: GitHub
- URL: https://github.com/f1lt3r/balanced-pairs
- Owner: F1LT3R
- License: mit
- Created: 2018-04-23T11:59:18.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-04-25T21:14:34.000Z (over 6 years ago)
- Last Synced: 2024-10-11T20:23:07.958Z (2 months ago)
- Topics: balance, blocks, brace, code-fence, delimiters, even, match, pairs, parse, tags, uneven
- Language: JavaScript
- Homepage: https://f1lt3r.io
- Size: 25.4 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Balanced-Pairs
> 🏄 get block contents between balanced pairs, eg: {} \\ or code fences
[](https://travis-ci.org/F1LT3R/balanced-pairs)
[](https://coveralls.io/github/F1LT3R/balanced-pairs?branch=master)
[](https://www.npmjs.com/package/balanced-pairs)
[](https://github.com/sindresorhus/xo)
Support the development of Balanced-Pairs.
## Install
```bash
# NPM
npm install --save balanced-pairs
# Yarn
yarn add balanced-pairs
```
## Uneven Pairs
An "Uneven Pair" is a pair of varying block delimiters. For example: HTML tags.
- Uneven pairs can be nested.
- Uneven pairs return:
+ A nested tree of blocks.
+ A linear array of blocks in the order they were closed.
+ A object containing blocks mapped to their depth.
- An `inside(charPos)` function that returns all the nested blocks that the character is within.
- Each block contains an `updateBody()` function that sets the `.newBody` property on each block
- Result has a `.flatten()` method, to turn the block tree back into a string, replacing the old content with the updated content
```js
const balance = require('balanced-pairs')
const content = 'Foo
bar baz
qux.'
const result = balance(content, {
open: '
',
close: ''
})
console.log(result.blocks)
```
Result:
```js
{
blocks: [{
start: 0,
end: 37,
depth: 0,
body: 'Foo
bar baz
qux.',
root: true,
children: [{
start: 9,
end: 26,
depth: 1,
pre: 'Foo ',
body: 'bar baz',
post: ' qux.',
root: false,
delimiter: {
start: 4,
end: 32,
pre: 'Foo ',
body: 'bar baz
',
post: ' qux.'
},
children: [{
start: 18,
end: 20,
depth: 2,
pre: 'Foo bar ',
body: 'baz',
post: '
qux.',
root: false,
delimiter: {
start: 13,
end: 26,
pre: 'Foo bar ',
body: 'baz',
post: ' qux.'
},
children: []
}]
}]
}],
polygon: [],
mode: 'odd',
inside: [Function: inside],
levels: {
'1': [{
start: 9,
end: 26,
depth: 1,
pre: 'Foo ',
body: 'bar baz',
post: ' qux.',
root: false,
delimiter: {
start: 4,
end: 32,
pre: 'Foo ',
body: 'bar baz
',
post: ' qux.'
},
children: [{
start: 18,
end: 20,
depth: 2,
pre: 'Foo bar ',
body: 'baz',
post: '
qux.',
root: false,
delimiter: {
start: 13,
end: 26,
pre: 'Foo bar ',
body: 'baz',
post: ' qux.'
},
children: []
}]
}],
'2': [{
start: 18,
end: 20,
depth: 2,
pre: 'Foo bar ',
body: 'baz',
post: '
qux.',
root: false,
delimiter: {
start: 13,
end: 26,
pre: 'Foo bar ',
body: 'baz',
post: ' qux.'
},
children: []
}]
},
list: [{
start: 18,
end: 20,
depth: 2,
pre: 'Foo bar ',
body: 'baz',
post: '
qux.',
root: false,
delimiter: {
start: 13,
end: 26,
pre: 'Foo bar ',
body: 'baz',
post: ' qux.'
},
children: []
}, {
start: 9,
end: 26,
depth: 1,
pre: 'Foo ',
body: 'bar baz',
post: ' qux.',
root: false,
delimiter: {
start: 4,
end: 32,
pre: 'Foo ',
body: 'bar baz
',
post: ' qux.'
},
children: [{
start: 18,
end: 20,
depth: 2,
pre: 'Foo bar ',
body: 'baz',
post: '
qux.',
root: false,
delimiter: {
start: 13,
end: 26,
pre: 'Foo bar ',
body: 'baz',
post: ' qux.'
},
children: []
}]
}]
}
```
### Flatten
Each block contains an `updateBody()` function that sets the `.newBody` property on each block.
Result has a `.flatten()` method, to turn the block tree back into a string, replacing the old content with the updated content
Note: flattening a block will remove it's delimiters within the parent.
```js
const source = '0{1}{2}3'
const result = balance(source, {
open: '{',
close: '}'
})
result.blocks[0].children[0].updateBody('x')
result.blocks[0].children[1].updateBody('y')
const flattened = result.flatten()
console.log(flattened) // '0xy3'
```
You can also flatten nested content:
```js
const source = '0{1{2{3{4}}}}'
const result = balance(source, {
open: '{',
close: '}'
})
// result.blocks[0] = the root block
const block4 = result.blocks[0]
.children[0]
.children[0]
.children[0]
.children[0]
block4.updateBody('[BEEP!]')
const flattened = result.flatten()
console.log(flattened) // 0{1{2{3[BEEP!]}}}
```
## Even Pairs
An "Even Pair" is a pair of identical block delimiters. For example: a markdown code-fence.
- Even pairs do not nest.
- Even pairs return a linear array of blocks.
- Even pairs return a polygon that can be used to determine whether any character position is inside or outside of a block.
- An `inside(charPos)` function to check whether any character is within a block.
Example:
```js
const balance = require('balanced-pairs')
const content = 'FOO ```BAR``` BAZ ```QUX```'
const result = balance(content, {
open: '```',
close: '```'
})
console.log(result.blocks)
```
Result:
```js
[ { start: 7,
end: 9,
pre: 'FOO ```',
body: 'BAR',
post: '``` BAZ ```QUX```',
polygon: [ [ 7, -1 ], [ 10, -1 ], [ 10, 1 ], [ 7, 1 ], [ 7, -1 ] ],
delimiter:
{ start: 4,
end: 12,
pre: 'FOO ',
body: '```BAR```',
post: '``` BAZ ```QUX```' } },
{ start: 21,
end: 23,
pre: 'FOO ```BAR``` BAZ ```',
body: 'QUX',
post: '```',
polygon: [ [ 21, -1 ], [ 24, -1 ], [ 24, 1 ], [ 21, 1 ], [ 21, -1 ] ],
delimiter:
{ start: 18,
end: 26,
pre: 'FOO ```BAR``` BAZ ',
body: '```QUX```',
post: '```' } } ],
polygon:
[ [ 7, -1 ],
[ 10, -1 ],
[ 10, 1 ],
[ 7, 1 ],
[ 7, -1 ],
[ 21, -1 ],
[ 24, -1 ],
[ 24, 1 ],
[ 21, 1 ],
[ 21, -1 ] ],
mode: 'even',
inside: [Function: inside] }
```