Remove type support

All tree’s, whether abstract or concrete, are in the future placed under `tree` instead of `ast` or `cst`.
unifiedjs · Sep 14, 2015 · 8748cfe · 8748cfe
1 parent 6dae05d
commit 8748cfe
Show file tree

Hide file tree

Showing 5 changed files with 224 additions and 125 deletions.
diff --git a/index.js b/index.js
@@ -39,7 +39,6 @@ var pipeline = ware()
  *
  * @param {Object} options - Configuration.
  * @param {string} options.name - Private storage.
- * @param {string} options.type - Type of syntax tree.
  * @param {Function} options.Parser - Class to turn a
  *   virtual file into a syntax tree.
  * @param {Function} options.Compiler - Class to turn a
@@ -48,7 +47,6 @@ var pipeline = ware()
  */
 function unified(options) {
     var name = options.name;
-    var type = options.type;
     var Parser = options.Parser;
     var Compiler = options.Compiler;
 
@@ -129,9 +127,9 @@ function unified(options) {
         space = file.namespace(name);
 
         if (!node) {
-            node = space[type] || node;
-        } else if (!space[type]) {
-            space[type] = node;
+            node = space.tree || node;
+        } else if (!space.tree) {
+            space.tree = node;
         }
 
         if (!node) {
@@ -171,7 +169,7 @@ function unified(options) {
         var CustomParser = (this && this.Parser) || Parser;
         var node = new CustomParser(file, settings).parse();
 
-        file.namespace(name)[type] = node;
+        file.namespace(name).tree = node;
 
         return node;
     }
@@ -180,7 +178,7 @@ function unified(options) {
      * Compile a file.
      *
      * Used the parsed node at the `name`
-     * namespace at `type` when no node was given.
+     * namespace at `'tree'` when no node was given.
      *
      * @this {Processor?} - Either a Processor instance or
      *   the Processor constructor.
@@ -207,9 +205,9 @@ function unified(options) {
         space = file.namespace(name);
 
         if (!node) {
-            node = space[type] || node;
-        } else if (!space[type]) {
-            space[type] = node;
+            node = space.tree || node;
+        } else if (!space.tree) {
+            space.tree = node;
         }
 
         if (!node) {

diff --git a/readme.md b/readme.md
@@ -30,7 +30,6 @@ var Compiler = require('./lib/stringify.js');
 
 module.exports = unified({
     'name': 'mdast',
-    'type': 'ast',
     'Parser': Parser,
     'Compiler': Compiler
 });
@@ -78,13 +77,6 @@ Create a new `Processor` constructor.
 
 *   `name` (`string`) — Unique namespace, e.g. `'mdast'` or `'retext'`.
 
-*   `type` (`string`) — Type of the produced syntax tree. For example,
-    **mdast** uses an `'ast'` (Abstract Syntax Tree), whereas **retext**
-    uses a `'cst'` (Concrete Syntax Tree).
-
-    Used to store the syntax tree after parsing on the file (at
-    `file.namespace(name)[type]`).
-
 *   `Parser` (`Function`) — Constructor which transforms a virtual file
     into a syntax tree. When input is parsed, this function will be
     constructed with a `file` and `settings`. `Parser` instances should
@@ -100,15 +92,15 @@ Create a new `Processor` constructor.
     have a `compile` method which returns a `string`.
 
     The syntax tree representation of a file can be accessed by executing
-    `file.namespace(name)[type]`.
+    `file.namespace(name).tree`.
 
 **Returns** — `Function` (`Processor` constructor).
 
 ### Processor(\[processor\])
 
 > Note that all methods on the instance are also available as functions on the
 > constructor, which, when invoked, create a new instance.
->
+> 
 > Thus, invoking `new Processor().process()` is the same as
 > `Processor.process()`.
 

diff --git a/test.js b/test.js
@@ -36,7 +36,6 @@ describe('unified()', function () {
     it('should create a new constructor', function () {
         Processor = unified({
             'name': 'foo',
-            'type': 'bar',
             'Parser': noop,
             'Compiler': noop
         });
@@ -200,7 +199,6 @@ describe('unified()', function () {
 
                 var parse = unified({
                     'name': 'foo',
-                    'type': 'bar',
                     'Parser': Bound,
                     'Compiler': noop
                 }).parse;
@@ -262,7 +260,7 @@ describe('unified()', function () {
                 'value': 'bar'
             };
 
-            vfile.namespace('foo').bar = node;
+            vfile.namespace('foo').tree = node;
 
             new Processor().run(vfile, function (err, tree, file) {
                 equal(err, null);
@@ -280,7 +278,7 @@ describe('unified()', function () {
                 'value': 'bar'
             };
 
-            vfile.namespace('foo').bar = node;
+            vfile.namespace('foo').tree = node;
 
             new Processor().run(node, vfile, function (err, tree, file) {
                 equal(err, null);
@@ -317,7 +315,7 @@ describe('unified()', function () {
             function Compiler(file, options) {
                 self = this;
 
-                equal(file.namespace('foo').bar, node);
+                equal(file.namespace('foo').tree, node);
                 equal(options, 'bar');
             }
 
@@ -361,7 +359,7 @@ describe('unified()', function () {
 
             Compiler.prototype.compile = done;
 
-            vfile.namespace('foo').bar = tree;
+            vfile.namespace('foo').tree = tree;
 
             Processor.Compiler = Compiler;
 
@@ -409,7 +407,7 @@ describe('unified()', function () {
 
             Processor.Compiler = Compiler;
 
-            vfile.namespace('foo').bar = tree;
+            vfile.namespace('foo').tree = tree;
 
             Processor.stringify(vfile);
 
@@ -438,7 +436,7 @@ describe('unified()', function () {
 
             Processor.Compiler = Compiler;
 
-            vfile.namespace('foo').bar = tree;
+            vfile.namespace('foo').tree = tree;
 
             Processor.stringify(tree, vfile, settings);
 
@@ -467,7 +465,6 @@ describe('unified()', function () {
 
                 var stringify = unified({
                     'name': 'foo',
-                    'type': 'bar',
                     'Parser': noop,
                     'Compiler': Bound
                 }).stringify;
@@ -520,7 +517,6 @@ describe('unified()', function () {
 
             Processor2 = unified({
                 'name': 'foo',
-                'type': 'bar',
                 'Parser': Parser,
                 'Compiler': Compiler
             });
@@ -576,7 +572,6 @@ describe('unified()', function () {
 
             Processor2 = unified({
                 'name': 'foo',
-                'type': 'bar',
                 'Parser': Parser,
                 'Compiler': Compiler
             });
@@ -629,7 +624,6 @@ describe('unified()', function () {
 
             Processor2 = unified({
                 'name': 'foo',
-                'type': 'bar',
                 'Parser': Parser,
                 'Compiler': Compiler
             });
@@ -686,7 +680,6 @@ describe('unified()', function () {
 
             Processor2 = unified({
                 'name': 'foo',
-                'type': 'bar',
                 'Parser': Parser,
                 'Compiler': Compiler
             });
@@ -746,7 +739,6 @@ describe('unified()', function () {
 
             Processor2 = unified({
                 'name': 'foo',
-                'type': 'bar',
                 'Parser': Parser,
                 'Compiler': Compiler
             });
@@ -805,7 +797,6 @@ describe('unified()', function () {
 
             Processor2 = unified({
                 'name': 'foo',
-                'type': 'bar',
                 'Parser': Parser,
                 'Compiler': Compiler
             });
@@ -868,7 +859,6 @@ describe('unified()', function () {
 
             processor = unified({
                 'name': 'foo',
-                'type': 'bar',
                 'Parser': Parser,
                 'Compiler': Compiler
             });
@@ -905,7 +895,6 @@ describe('unified()', function () {
 
             processor = unified({
                 'name': 'foo',
-                'type': 'bar',
                 'Parser': Parser,
                 'Compiler': noop
             });
@@ -952,7 +941,6 @@ describe('unified()', function () {
 
             processor = unified({
                 'name': 'foo',
-                'type': 'bar',
                 'Parser': Parser,
                 'Compiler': Compiler
             });
@@ -984,7 +972,6 @@ describe('unified()', function () {
 
             processor = unified({
                 'name': 'foo',
-                'type': 'bar',
                 'Parser': Parser,
                 'Compiler': noop
             }).use(function () {
@@ -1017,7 +1004,6 @@ describe('unified()', function () {
 
             unified({
                 'name': 'foo',
-                'type': 'bar',
                 'Parser': Parser,
                 'Compiler': noop
             }).process('foo', function (err) {
@@ -1061,7 +1047,6 @@ describe('unified()', function () {
 
             unified({
                 'name': 'foo',
-                'type': 'bar',
                 'Parser': Parser,
                 'Compiler': Compiler
             }).process('foo', function (err) {
@@ -1090,7 +1075,6 @@ describe('unified()', function () {
 
             unified({
                 'name': 'foo',
-                'type': 'bar',
                 'Parser': Parser,
                 'Compiler': noop
             }).use(function () {