Refactor module

*   Remove support for optional parsers (they are now
    required);
*   Remove support for storing `nlcst` on the file;
*   Remove support for `cst` and `ast` properties,
    replaced with `tree`:

    unifiedjs/unified@8748cfe

Author: wooorm

component.json

@@ -11,9 +11,8 @@
     "language"
   ],
   "dependencies": {
-    "wooorm/mdast-range": "^0.4.3",
-    "wooorm/parse-latin": "^0.5.1",
-    "wooorm/nlcst-to-string": "^0.1.5"
+    "wooorm/mdast-range": "^1.0.0",
+    "wooorm/nlcst-to-string": "^1.0.0"
   },
   "repository": "wooorm/mdast-util-to-nlcst",
   "scripts": [

index.js

@@ -16,7 +16,6 @@
  */
 
 var range = require('mdast-range');
-var Latin = require('parse-latin');
 var toString = require('nlcst-to-string');
 
 /*
@@ -216,14 +215,14 @@ one = function (node, index, parent, file, parser) {
  * Transform `ast` into `nlcst`.
  *
  * @param {File} file - Virtual file.
- * @param {Function?} [Parser] - Constructor of an nlcst
- *   parser. Defaults to `ParseLatin`.
+ * @param {Parser|Function} Parser - (Instance of) NLCST
+ *   parser.
  * @return {NLCSTNode} - NLCST.
  */
 function toNLCST(file, Parser) {
     var ast;
+    var space;
     var parser;
-    var cst;
 
     /*
      * Warn for invalid parameters.
@@ -233,7 +232,8 @@ function toNLCST(file, Parser) {
         throw new Error('mdast-util-to-nlcst expected file');
     }
 
-    ast = file.namespace('mdast').ast;
+    space = file.namespace('mdast');
+    ast = space.tree || space.ast;
 
     if (!ast || !ast.type) {
         throw new Error('mdast-util-to-nlcst expected node');
@@ -253,17 +253,10 @@ function toNLCST(file, Parser) {
      */
 
     if (!Parser) {
-        Parser = Latin;
+        throw new Error('mdast-util-to-nlcst expected parser');
     }
 
-    if ('parse' in Parser) {
-        parser = Parser;
-        parser.position = true;
-    } else {
-        parser = new Parser({
-            'position': true
-        });
-    }
+    parser = 'parse' in Parser ? Parser : new Parser();
 
     /*
      * Patch ranges.
@@ -277,11 +270,7 @@ function toNLCST(file, Parser) {
      * where needed.
      */
 
-    cst = parser.parse(one(ast, null, null, file, parser));
-
-    file.namespace('retext').cst = cst;
-
-    return cst;
+    return parser.parse(one(ast, null, null, file, parser));
 }
 
 /*

mdast-util-to-nlcst.js

@@ -12,7 +12,6 @@
   ],
   "dependencies": {
     "mdast-range": "^1.0.0",
-    "parse-latin": "^2.0.0",
     "nlcst-to-string": "^1.0.0"
   },
   "repository": {
@@ -43,6 +42,7 @@
     "mocha": "^2.0.0",
     "parse-dutch": "^2.0.0",
     "parse-english": "^2.0.0",
+    "parse-latin": "^2.0.0",
     "vfile": "^1.0.0"
   },
   "scripts": {

mdast-util-to-nlcst.min.js

@@ -195,22 +195,23 @@ mdast.process('Some *foo*s-_ball_.', function (err, doc, file) {
 
 ## API
 
-### toNLCST(file\[, Parser | parser\])
+### toNLCST(file, Parser | parser)
 
 Transform a by [**mdast**](https://github.com/wooorm/mdast) processed
-[**virtual file**](https://github.com/wooorm/vfile) into an file ready
-for processing by [**retext**](https://github.com/wooorm/retext).
+[**virtual file**](https://github.com/wooorm/vfile) into a
+[NLCST](https://github.com/wooorm/nlcst) tree for
+[**retext**](https://github.com/wooorm/retext).
 
 Parameters:
 
 *   `file` (`File`)
     — [Virtual file](https://github.com/wooorm/vfile), must be passed through
     [`parse()`](https://github.com/wooorm/mdast/blob/master/doc/mdast.3.md#mdastparsefile-options).
 
-*   `parser` (`Function` or `Parser`, default: `new ParseLatin()`, optional)
+*   `parser` (`Function` or `Parser`, optional)
     — You can pass the (constructor of) an NLCST parser, such as
-    [**parse-english**](https://github.com/wooorm/parse-english) or
-    [**parse-dutch**](https://github.com/wooorm/parse-dutch), the default is
+    [**parse-english**](https://github.com/wooorm/parse-english),
+    [**parse-dutch**](https://github.com/wooorm/parse-dutch), or
     [**parse-latin**](https://github.com/wooorm/parse-latin).
 
 Returns:

package.json

@@ -11,6 +11,7 @@ var fs = require('fs');
 var path = require('path');
 var mdast = require('mdast');
 var VFile = require('vfile');
+var Latin = require('parse-latin');
 var Dutch = require('parse-dutch');
 var English = require('parse-english');
 var toNLCST = require('..');
@@ -37,9 +38,10 @@ var fixtures = fs.readdirSync(ROOT);
 /**
  * Helper to create a new file from a given cst.
  */
-function toFile(ast) {
+function toFile(tree) {
     var file = new VFile();
-    file.namespace('mdast').ast = ast;
+
+    file.namespace('mdast').tree = tree;
 
     return file;
 }
@@ -86,7 +88,7 @@ describe('mdast-util-to-nlcst', function () {
         }, /mdast-util-to-nlcst expected file/);
     });
 
-    it('should fail when not given a positional information', function () {
+    it('should fail when not given positional information', function () {
         assert.throws(function () {
             toNLCST(toFile({
                 'type': 'text',
@@ -122,13 +124,13 @@ describe('mdast-util-to-nlcst', function () {
             }
         };
 
-        toNLCST(toFile(node));
+        toNLCST(toFile(node), Latin);
 
         assert.equal(node.position.start.offset, 0);
         assert.equal(node.position.end.offset, 3);
     });
 
-    it('should accept an optional parser', function () {
+    it('should accept a parser', function () {
         var node = {
             'type': 'text',
             'value': 'foo',
@@ -144,9 +146,9 @@ describe('mdast-util-to-nlcst', function () {
             }
         };
 
-        assert.doesNotThrow(function () {
+        assert.throws(function () {
             toNLCST(toFile(node));
-        });
+        }, /mdast-util-to-nlcst expected parser/);
 
         assert.doesNotThrow(function () {
             toNLCST(toFile(node), English);
@@ -178,14 +180,8 @@ function describeFixture(fixture) {
         var input = read(join(filepath, 'input.md'), 'utf-8');
 
         mdast().process(input, function (err, file) {
-            var cst;
-
+            assert.deepEqual(toNLCST(file, Latin), JSON.parse(output));
             done(err);
-
-            cst = toNLCST(file);
-
-            assert.deepEqual(cst, JSON.parse(output));
-            assert.equal(cst, file.namespace('retext').cst);
         });
     });
 }