flat-text-sequencer

▶ flat text sequencer

Looking to parse a custom text model, render markdown, or highlight code? Here's a module that chunks text into a sequence of typed ranges by pattern.

sequence('*if only* there was a way to make `this` a __sequence__', [
  { type: 'strong', pattern: /__.+?__/g },
  { type: 'em', pattern: /\*.+?\*/g },
  { type: 'code', pattern: /`.+?`/g }
])

From text to a sequence.

[
  { type: ['em'], data: '*if only*' },
  { type: [], data: ' there was a way to make ' },
  { type: ['code'], data: '`this`' },
  { type: [], data: ' a ' },
  { type: ['strong'], data: '__sequence__' }
]

Usage

Install it with npm:

npm install --save flat-text-sequencer

Load the package to your application:

const sequenceText = require('flat-text-sequecner')

And call it with your data:

const sequence = sequenceText(text, patterns)

API

Flat text sequencer exports a single function with the following signature:

(text: string, patterns: [{ type: string, pattern: RegExp }])
-> [{ type: [string], data: string }]

Author

Joonatan Vuorinen (@bearror)