mdast-util-to-nlcst

mdast-util-to-nlcst

Transform MDAST to NLCST.

Note You probably want to use remark-retext.

Installation

npm:

npm install mdast-util-to-nlcst

Usage

Dependencies:

var toNLCST = require('mdast-util-to-nlcst');
var inspect = require('unist-util-inspect');
var English = require('parse-english');
var remark = require('remark');
var vfile = require('vfile');

Process:

var file = vfile('Some *foo*sball.');
var tree = remark().parse(file);

Stringify:

var nlcst = toNLCST(tree, file, English);

Which, when inspecting, yields:

RootNode[1] (1:1-1:17, 0-16)
└─ ParagraphNode[1] (1:1-1:17, 0-16)
   └─ SentenceNode[4] (1:1-1:17, 0-16)
      ├─ WordNode[1] (1:1-1:5, 0-4)
      │  └─ TextNode: "Some" (1:1-1:5, 0-4)
      ├─ WhiteSpaceNode: " " (1:5-1:6, 4-5)
      ├─ WordNode[2] (1:7-1:16, 6-15)
      │  ├─ TextNode: "foo" (1:7-1:10, 6-9)
      │  └─ TextNode: "sball" (1:11-1:16, 10-15)
      └─ PunctuationNode: "." (1:16-1:17, 15-16)

API

toNLCST(node, file, Parser)

Transform an MDAST syntax tree and corresponding virtual file into an NLCST tree.

Parameters

• node (MDASTNode) — Syntax tree (with positional information);
• file (VFile);
• parser (Function) — Constructor of an NLCST parser, such as parse-english, parse-dutch, or parse-latin.

Returns

NLCSTNode.

License

MIT © Titus Wormer