jsontree

Converts a JSON object into an Ordered Labeled Tree (OLT)

npm install jsontree
22 downloads in the last month

An Ordered Labeled Tree(OLT) is a data structure that consists of nodes with labels and children, where the children are nodes themselves. The order of the children is significant. There are a number of algorithms for calculating the difference (like the diff command does for text data) for these data structures.

This module takes a JSON data structure and creates a corresponding OLT.

  assert.deepEqual(jsontree.toTree({
   "key": "value",
   "list": [
     "one",
     "two"
   ],
   "object": {
     "woho": "works"
   }
  }), {
    "type": "Object",
    "children": [
      {
        "type": "Value",
        "name": "key",
        "value": "value"
      },
      {
        "type": "List",
        "name": "list",
        "children": [
          {
            "type": "Value",
            "value": "one"
          },
          {
            "type": "Value",
            "value": "two"
          }
        ]
      },
      {
        "type": "Object",
        "name": "object",
        "children": [
          {
            "type": "Value",
            "name": "woho",
            "value": "works"
          }
        ]
      }
    ]
  });

Note that each node has up to four fields:

  • type
  • name
  • value
  • children

This is not a problem, since the set [type, name, value] can be considered as the label of the node.

Why

I'm looking into creating a diff tool for the Abstract Syntax Tree's of JavaScript code. The AST can be generated using esprima, but this will give us a syntax tree in the format of a JavaScript object. The existing algorithms for calculating tree differences only works on OLT's.

See Simple fast algorithms for the editing distance between trees and related problems by K. Zhang and D. Shasha.

npm loves you