@atjson/renderer-graphviz - npm Package Compare versions

Comparing version 0.9.0 to 0.11.0

CHANGELOG.md

@@ -6,2 +6,29 @@ # Change Log
 
+## [0.11.0](https://github.com/CondeNast-Copilot/atjson/compare/@atjson/renderer-graphviz@0.9.0...@atjson/renderer-graphviz@0.11.0) (2018-10-22)
+
+
+### ✨ New Features
+
+* ✨👑✨ Make Annotations classes instead of JS objects ([#57](https://github.com/CondeNast-Copilot/atjson/issues/57))
+
+
+### 🚨 Breaking Changes
+
+* This introduces a bunch of breaking changes to AtJSON. The major change is that Annotations are now described as classes instead of a loose schema.
+
+A summary of changes are the following:
+
+⚠️ `@atjson/schema` is now deprecated. Instead of using the schema, instead use `@atjson/offset-annotations`, which provides a library of annotations that closely resemble those provided by  `@atjson/schema`
+
+🃏 Schemas are now defined on a document subclass. The schema is a list of annotation classes that are used to identify annotations in the document.
+
+🛸 Any annotations not found in the schema are identified as `unknown` annotations. These annotations are available to be read and updated like any other annotation, but may have incorrect transform behavior because the text transform behavior  is undefined. The default behavior should be acceptable for most cases.
+
+🕵🏾‍♀️ `id`s are required property on Annotations. This is used to identify annotations for speedy updating for Offset
+
+🖍 Annotations are now prefixed at rest. For the CommonMark Link annotation, it will be stored as `-commonmark-link` as the `type` and the attributes will be prefixed with `-commonmark` as well, meaning that instead of seeing `href` in the `attributes`, you will see `-commonmark-href`. When the annotation JSON is hydrated into an annotation class, prefixes are automatically removed. This prevents any collisions that may (and will) happen when converting between document types.
+
+🎨 Renderers now take `Annotation`s instead of the `attributes`.  When additional context is required to render an annotation, a `context` object is passed as the second argument, which provides references to the `parent`, `next`, `previous`, and `children` annotations to the current annotation.
+
+
 ## [0.9.0](https://github.com/CondeNast-Copilot/atjson/compare/@atjson/renderer-graphviz@0.8.11...@atjson/renderer-graphviz@0.9.0) (2018-10-10)
@@ -8,0 +35,0 @@

dist/commonjs/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const hir_1 = require("@atjson/hir");
+function getColor(annotation) {
+    if (annotation.rank === -Infinity) {
+        return 'style=filled fillcolor="#000000" fontcolor="#FFFFFF"';
+    }
+    else if (annotation.rank <= 0) {
+        return 'style=filled fillcolor="#222222" fontcolor="#FFFFFF"';
+    }
+    else if (annotation.rank <= 10) {
+        return 'style=filled fillcolor="#444444" fontcolor="#FFFFFF"';
+    }
+    else if (annotation.rank <= 50) {
+        return 'style=filled fillcolor="#666666" fontcolor="#FFFFFF"';
+    }
+    else if (annotation.rank <= 100) {
+        return 'style=filled fillcolor="#888888" fontcolor="#FFFFFF"';
+    }
+    else if (annotation.rank <= 1000) {
+        return 'style=filled fillcolor="#AAAAAA" fontcolor="#000000"';
+    }
+    else if (annotation.rank <= Number.MAX_SAFE_INTEGER) {
+        return 'style=filled fillcolor="#CCCCCC" fontcolor="#000000"';
+    }
+    else {
+        return 'style=filled fillcolor="#FFFFFF" fontcolor="#000000"';
+    }
+}
 function generateGraph(hirNode, edges, nodes) {
-    let children = hirNode.children();
+    let children = hirNode.children({ includeParseTokens: true });
     let text = hirNode.type;
-    if (hirNode.type === 'text' && hirNode.text != null) {
-        text = hirNode.text;
+    if (hirNode.type === 'text' && hirNode.attributes.text != null) {
+        text = hirNode.annotation.attributes.text;
     }
@@ -14,4 +40,5 @@ else {
     let node = {
-        id: `${hirNode.type}${nodes.length + 1}`,
+        id: `${hirNode.type.replace('-', '_')}${nodes.length + 1}`,
         label: hirNode.type,
+        color: getColor(hirNode.annotation),
         text
@@ -32,7 +59,7 @@ };
         if (options.shape === 'record' || options.shape === 'Mrecord') {
-            dot = nodes.map(node => `  ${node.id} [label="{${node.label}|${node.text.replace(/"/g, '\\"')}}"];`).join('\n') + '\n' +
+            dot = nodes.map(node => `  ${node.id} [label="{${node.label}|${node.text.replace(/"/g, '\\"')}}" ${node.color}];`).join('\n') + '\n' +
                 edges.map(([parent, child]) => `  ${parent.id} -> ${child.id};`).join('\n');
         }
         else {
-            dot = nodes.map(node => `  ${node.id} [label="${node.label}\\n${node.text.replace(/"/g, '\\"')}"];`).join('\n') + '\n' +
+            dot = nodes.map(node => `  ${node.id} [label="${node.label}\\n${node.text.replace(/"/g, '\\"')}" ${node.color}];`).join('\n') + '\n' +
                 edges.map(([parent, child]) => `  ${parent.id} -> ${child.id};`).join('\n');
@@ -47,2 +74,2 @@ }
 exports.default = GraphvizRenderer;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFDQSxxQ0FBMkM7QUFRM0MsU0FBUyxhQUFhLENBQUMsT0FBZ0IsRUFBRSxLQUEwQixFQUFFLEtBQWE7SUFDaEYsSUFBSSxRQUFRLEdBQUcsT0FBTyxDQUFDLFFBQVEsRUFBRSxDQUFDO0lBQ2xDLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUM7SUFDeEIsSUFBSSxPQUFPLENBQUMsSUFBSSxLQUFLLE1BQU0sSUFBSSxPQUFPLENBQUMsSUFBSSxJQUFJLElBQUksRUFBRTtRQUNuRCxJQUFJLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQztLQUNyQjtTQUFNO1FBQ0wsSUFBSSxHQUFHLElBQUksQ0FBQyxTQUFTLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxDQUFDO0tBQzNDO0lBRUQsSUFBSSxJQUFJLEdBQUc7UUFDVCxFQUFFLEVBQUUsR0FBRyxPQUFPLENBQUMsSUFBSSxHQUFHLEtBQUssQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFO1FBQ3hDLEtBQUssRUFBRSxPQUFPLENBQUMsSUFBSTtRQUNuQixJQUFJO0tBQ0wsQ0FBQztJQUNGLEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7SUFFakIsUUFBUSxDQUFDLE9BQU8sQ0FBQyxDQUFDLEtBQWMsRUFBRSxFQUFFO1FBQ2xDLEtBQUssQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLEVBQUUsYUFBYSxDQUFDLEtBQUssRUFBRSxLQUFLLEVBQUUsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ3pELENBQUMsQ0FBQyxDQUFDO0lBRUgsT0FBTyxJQUFJLENBQUM7QUFDZCxDQUFDO0FBTUQsTUFBcUIsZ0JBQWdCO0lBQ25DLE1BQU0sQ0FBQyxRQUFrQixFQUFFLFVBQTJCLEVBQUUsS0FBSyxFQUFFLE1BQU0sRUFBRTtRQUNyRSxJQUFJLEtBQUssR0FBd0IsRUFBRSxDQUFDO1FBQ3BDLElBQUksS0FBSyxHQUFXLEVBQUUsQ0FBQztRQUN2QixhQUFhLENBQUMsSUFBSSxTQUFHLENBQUMsUUFBUSxDQUFDLENBQUMsUUFBUSxFQUFFLEtBQUssRUFBRSxLQUFLLENBQUMsQ0FBQztRQUV4RCxJQUFJLEdBQVcsQ0FBQztRQUNoQixJQUFJLE9BQU8sQ0FBQyxLQUFLLEtBQUssUUFBUSxJQUFJLE9BQU8sQ0FBQyxLQUFLLEtBQUssU0FBUyxFQUFFO1lBQzdELEdBQUcsR0FBRyxLQUFLLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsS0FBSyxJQUFJLENBQUMsRUFBRSxhQUFhLElBQUksQ0FBQyxLQUFLLElBQUksSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxFQUFFLEtBQUssQ0FBQyxNQUFNLENBQUMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsSUFBSTtnQkFDaEgsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsTUFBTSxFQUFFLEtBQUssQ0FBQyxFQUFFLEVBQUUsQ0FBQyxLQUFLLE1BQU0sQ0FBQyxFQUFFLE9BQU8sS0FBSyxDQUFDLEVBQUUsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1NBQ25GO2FBQU07WUFDTCxHQUFHLEdBQUcsS0FBSyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLEtBQUssSUFBSSxDQUFDLEVBQUUsWUFBWSxJQUFJLENBQUMsS0FBSyxNQUFNLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksRUFBRSxLQUFLLENBQUMsS0FBSyxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLElBQUk7Z0JBQ2hILEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLE1BQU0sRUFBRSxLQUFLLENBQUMsRUFBRSxFQUFFLENBQUMsS0FBSyxNQUFNLENBQUMsRUFBRSxPQUFPLEtBQUssQ0FBQyxFQUFFLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztTQUNuRjtRQUVELE9BQU87Z0JBQ0ssT0FBTyxDQUFDLEtBQUs7RUFDM0IsR0FBRztFQUNILENBQUM7SUFDRCxDQUFDO0NBQ0Y7QUFwQkQsbUNBb0JDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFDQSxxQ0FBMkM7QUFTM0Msa0JBQWtCLFVBQXNCO0lBQ3RDLElBQUksVUFBVSxDQUFDLElBQUksS0FBSyxDQUFDLFFBQVEsRUFBRTtRQUNqQyxPQUFPLHNEQUFzRCxDQUFDO0tBQy9EO1NBQU0sSUFBSSxVQUFVLENBQUMsSUFBSSxJQUFJLENBQUMsRUFBRTtRQUMvQixPQUFPLHNEQUFzRCxDQUFDO0tBQy9EO1NBQU0sSUFBSSxVQUFVLENBQUMsSUFBSSxJQUFJLEVBQUUsRUFBRTtRQUNoQyxPQUFPLHNEQUFzRCxDQUFDO0tBQy9EO1NBQU0sSUFBSSxVQUFVLENBQUMsSUFBSSxJQUFJLEVBQUUsRUFBRTtRQUNoQyxPQUFPLHNEQUFzRCxDQUFDO0tBQy9EO1NBQU0sSUFBSSxVQUFVLENBQUMsSUFBSSxJQUFJLEdBQUcsRUFBRTtRQUNqQyxPQUFPLHNEQUFzRCxDQUFDO0tBQy9EO1NBQU0sSUFBSSxVQUFVLENBQUMsSUFBSSxJQUFJLElBQUksRUFBRTtRQUNsQyxPQUFPLHNEQUFzRCxDQUFDO0tBQy9EO1NBQU0sSUFBSSxVQUFVLENBQUMsSUFBSSxJQUFJLE1BQU0sQ0FBQyxnQkFBZ0IsRUFBRTtRQUNyRCxPQUFPLHNEQUFzRCxDQUFDO0tBQy9EO1NBQU07UUFDTCxPQUFPLHNEQUFzRCxDQUFDO0tBQy9EO0FBQ0gsQ0FBQztBQUVELHVCQUF1QixPQUFnQixFQUFFLEtBQTBCLEVBQUUsS0FBYTtJQUNoRixJQUFJLFFBQVEsR0FBRyxPQUFPLENBQUMsUUFBUSxDQUFDLEVBQUUsa0JBQWtCLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQztJQUM5RCxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDO0lBQ3hCLElBQUksT0FBTyxDQUFDLElBQUksS0FBSyxNQUFNLElBQUksT0FBTyxDQUFDLFVBQVUsQ0FBQyxJQUFJLElBQUksSUFBSSxFQUFFO1FBQzlELElBQUksR0FBRyxPQUFPLENBQUMsVUFBVSxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUM7S0FDM0M7U0FBTTtRQUNMLElBQUksR0FBRyxJQUFJLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUMsQ0FBQztLQUMzQztJQUVELElBQUksSUFBSSxHQUFHO1FBQ1QsRUFBRSxFQUFFLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxFQUFFLEdBQUcsQ0FBQyxHQUFHLEtBQUssQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFO1FBQzFELEtBQUssRUFBRSxPQUFPLENBQUMsSUFBSTtRQUNuQixLQUFLLEVBQUUsUUFBUSxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUM7UUFDbkMsSUFBSTtLQUNMLENBQUM7SUFDRixLQUFLLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO0lBRWpCLFFBQVEsQ0FBQyxPQUFPLENBQUMsQ0FBQyxLQUFjLEVBQUUsRUFBRTtRQUNsQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUMsSUFBSSxFQUFFLGFBQWEsQ0FBQyxLQUFLLEVBQUUsS0FBSyxFQUFFLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUN6RCxDQUFDLENBQUMsQ0FBQztJQUVILE9BQU8sSUFBSSxDQUFDO0FBQ2QsQ0FBQztBQU1EO0lBQ0UsTUFBTSxDQUFDLFFBQWtCLEVBQUUsVUFBMkIsRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFO1FBQ3JFLElBQUksS0FBSyxHQUF3QixFQUFFLENBQUM7UUFDcEMsSUFBSSxLQUFLLEdBQVcsRUFBRSxDQUFDO1FBQ3ZCLGFBQWEsQ0FBQyxJQUFJLFNBQUcsQ0FBQyxRQUFRLENBQUMsQ0FBQyxRQUFRLEVBQUUsS0FBSyxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBRXhELElBQUksR0FBVyxDQUFDO1FBQ2hCLElBQUksT0FBTyxDQUFDLEtBQUssS0FBSyxRQUFRLElBQUksT0FBTyxDQUFDLEtBQUssS0FBSyxTQUFTLEVBQUU7WUFDN0QsR0FBRyxHQUFHLEtBQUssQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxLQUFLLElBQUksQ0FBQyxFQUFFLGFBQWEsSUFBSSxDQUFDLEtBQUssSUFBSSxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUsS0FBSyxDQUFDLE1BQU0sSUFBSSxDQUFDLEtBQUssSUFBSSxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLElBQUk7Z0JBQzlILEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLE1BQU0sRUFBRSxLQUFLLENBQUMsRUFBRSxFQUFFLENBQUMsS0FBSyxNQUFNLENBQUMsRUFBRSxPQUFPLEtBQUssQ0FBQyxFQUFFLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztTQUNuRjthQUFNO1lBQ0wsR0FBRyxHQUFHLEtBQUssQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxLQUFLLElBQUksQ0FBQyxFQUFFLFlBQVksSUFBSSxDQUFDLEtBQUssTUFBTSxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUsS0FBSyxDQUFDLEtBQUssSUFBSSxDQUFDLEtBQUssSUFBSSxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLElBQUk7Z0JBQzlILEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLE1BQU0sRUFBRSxLQUFLLENBQUMsRUFBRSxFQUFFLENBQUMsS0FBSyxNQUFNLENBQUMsRUFBRSxPQUFPLEtBQUssQ0FBQyxFQUFFLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztTQUNuRjtRQUVELE9BQU87Z0JBQ0ssT0FBTyxDQUFDLEtBQUs7RUFDM0IsR0FBRztFQUNILENBQUM7SUFDRCxDQUFDO0NBQ0Y7QUFwQkQsbUNBb0JDIn0=

dist/modules/index.js

 import { HIR } from '@atjson/hir';
+function getColor(annotation) {
+    if (annotation.rank === -Infinity) {
+        return 'style=filled fillcolor="#000000" fontcolor="#FFFFFF"';
+    }
+    else if (annotation.rank <= 0) {
+        return 'style=filled fillcolor="#222222" fontcolor="#FFFFFF"';
+    }
+    else if (annotation.rank <= 10) {
+        return 'style=filled fillcolor="#444444" fontcolor="#FFFFFF"';
+    }
+    else if (annotation.rank <= 50) {
+        return 'style=filled fillcolor="#666666" fontcolor="#FFFFFF"';
+    }
+    else if (annotation.rank <= 100) {
+        return 'style=filled fillcolor="#888888" fontcolor="#FFFFFF"';
+    }
+    else if (annotation.rank <= 1000) {
+        return 'style=filled fillcolor="#AAAAAA" fontcolor="#000000"';
+    }
+    else if (annotation.rank <= Number.MAX_SAFE_INTEGER) {
+        return 'style=filled fillcolor="#CCCCCC" fontcolor="#000000"';
+    }
+    else {
+        return 'style=filled fillcolor="#FFFFFF" fontcolor="#000000"';
+    }
+}
 function generateGraph(hirNode, edges, nodes) {
-    let children = hirNode.children();
+    let children = hirNode.children({ includeParseTokens: true });
     let text = hirNode.type;
-    if (hirNode.type === 'text' && hirNode.text != null) {
-        text = hirNode.text;
+    if (hirNode.type === 'text' && hirNode.attributes.text != null) {
+        text = hirNode.annotation.attributes.text;
     }
@@ -12,4 +38,5 @@ else {
     let node = {
-        id: `${hirNode.type}${nodes.length + 1}`,
+        id: `${hirNode.type.replace('-', '_')}${nodes.length + 1}`,
         label: hirNode.type,
+        color: getColor(hirNode.annotation),
         text
@@ -30,7 +57,7 @@ };
         if (options.shape === 'record' || options.shape === 'Mrecord') {
-            dot = nodes.map(node => `  ${node.id} [label="{${node.label}|${node.text.replace(/"/g, '\\"')}}"];`).join('\n') + '\n' +
+            dot = nodes.map(node => `  ${node.id} [label="{${node.label}|${node.text.replace(/"/g, '\\"')}}" ${node.color}];`).join('\n') + '\n' +
                 edges.map(([parent, child]) => `  ${parent.id} -> ${child.id};`).join('\n');
         }
         else {
-            dot = nodes.map(node => `  ${node.id} [label="${node.label}\\n${node.text.replace(/"/g, '\\"')}"];`).join('\n') + '\n' +
+            dot = nodes.map(node => `  ${node.id} [label="${node.label}\\n${node.text.replace(/"/g, '\\"')}" ${node.color}];`).join('\n') + '\n' +
                 edges.map(([parent, child]) => `  ${parent.id} -> ${child.id};`).join('\n');
@@ -44,2 +71,2 @@ }
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUFFLEdBQUcsRUFBVyxNQUFNLGFBQWEsQ0FBQztBQVEzQyxTQUFTLGFBQWEsQ0FBQyxPQUFnQixFQUFFLEtBQTBCLEVBQUUsS0FBYTtJQUNoRixJQUFJLFFBQVEsR0FBRyxPQUFPLENBQUMsUUFBUSxFQUFFLENBQUM7SUFDbEMsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQztJQUN4QixJQUFJLE9BQU8sQ0FBQyxJQUFJLEtBQUssTUFBTSxJQUFJLE9BQU8sQ0FBQyxJQUFJLElBQUksSUFBSSxFQUFFO1FBQ25ELElBQUksR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDO0tBQ3JCO1NBQU07UUFDTCxJQUFJLEdBQUcsSUFBSSxDQUFDLFNBQVMsQ0FBQyxPQUFPLENBQUMsVUFBVSxDQUFDLENBQUM7S0FDM0M7SUFFRCxJQUFJLElBQUksR0FBRztRQUNULEVBQUUsRUFBRSxHQUFHLE9BQU8sQ0FBQyxJQUFJLEdBQUcsS0FBSyxDQUFDLE1BQU0sR0FBRyxDQUFDLEVBQUU7UUFDeEMsS0FBSyxFQUFFLE9BQU8sQ0FBQyxJQUFJO1FBQ25CLElBQUk7S0FDTCxDQUFDO0lBQ0YsS0FBSyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUVqQixRQUFRLENBQUMsT0FBTyxDQUFDLENBQUMsS0FBYyxFQUFFLEVBQUU7UUFDbEMsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDLElBQUksRUFBRSxhQUFhLENBQUMsS0FBSyxFQUFFLEtBQUssRUFBRSxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDekQsQ0FBQyxDQUFDLENBQUM7SUFFSCxPQUFPLElBQUksQ0FBQztBQUNkLENBQUM7QUFNRCxNQUFNLENBQUMsT0FBTyxPQUFPLGdCQUFnQjtJQUNuQyxNQUFNLENBQUMsUUFBa0IsRUFBRSxVQUEyQixFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUU7UUFDckUsSUFBSSxLQUFLLEdBQXdCLEVBQUUsQ0FBQztRQUNwQyxJQUFJLEtBQUssR0FBVyxFQUFFLENBQUM7UUFDdkIsYUFBYSxDQUFDLElBQUksR0FBRyxDQUFDLFFBQVEsQ0FBQyxDQUFDLFFBQVEsRUFBRSxLQUFLLEVBQUUsS0FBSyxDQUFDLENBQUM7UUFFeEQsSUFBSSxHQUFXLENBQUM7UUFDaEIsSUFBSSxPQUFPLENBQUMsS0FBSyxLQUFLLFFBQVEsSUFBSSxPQUFPLENBQUMsS0FBSyxLQUFLLFNBQVMsRUFBRTtZQUM3RCxHQUFHLEdBQUcsS0FBSyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLEtBQUssSUFBSSxDQUFDLEVBQUUsYUFBYSxJQUFJLENBQUMsS0FBSyxJQUFJLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksRUFBRSxLQUFLLENBQUMsTUFBTSxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLElBQUk7Z0JBQ2hILEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLE1BQU0sRUFBRSxLQUFLLENBQUMsRUFBRSxFQUFFLENBQUMsS0FBSyxNQUFNLENBQUMsRUFBRSxPQUFPLEtBQUssQ0FBQyxFQUFFLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztTQUNuRjthQUFNO1lBQ0wsR0FBRyxHQUFHLEtBQUssQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxLQUFLLElBQUksQ0FBQyxFQUFFLFlBQVksSUFBSSxDQUFDLEtBQUssTUFBTSxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUsS0FBSyxDQUFDLEtBQUssQ0FBQyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsR0FBRyxJQUFJO2dCQUNoSCxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxNQUFNLEVBQUUsS0FBSyxDQUFDLEVBQUUsRUFBRSxDQUFDLEtBQUssTUFBTSxDQUFDLEVBQUUsT0FBTyxLQUFLLENBQUMsRUFBRSxHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7U0FDbkY7UUFFRCxPQUFPO2dCQUNLLE9BQU8sQ0FBQyxLQUFLO0VBQzNCLEdBQUc7RUFDSCxDQUFDO0lBQ0QsQ0FBQztDQUNGIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUFFLEdBQUcsRUFBVyxNQUFNLGFBQWEsQ0FBQztBQVMzQyxrQkFBa0IsVUFBc0I7SUFDdEMsSUFBSSxVQUFVLENBQUMsSUFBSSxLQUFLLENBQUMsUUFBUSxFQUFFO1FBQ2pDLE9BQU8sc0RBQXNELENBQUM7S0FDL0Q7U0FBTSxJQUFJLFVBQVUsQ0FBQyxJQUFJLElBQUksQ0FBQyxFQUFFO1FBQy9CLE9BQU8sc0RBQXNELENBQUM7S0FDL0Q7U0FBTSxJQUFJLFVBQVUsQ0FBQyxJQUFJLElBQUksRUFBRSxFQUFFO1FBQ2hDLE9BQU8sc0RBQXNELENBQUM7S0FDL0Q7U0FBTSxJQUFJLFVBQVUsQ0FBQyxJQUFJLElBQUksRUFBRSxFQUFFO1FBQ2hDLE9BQU8sc0RBQXNELENBQUM7S0FDL0Q7U0FBTSxJQUFJLFVBQVUsQ0FBQyxJQUFJLElBQUksR0FBRyxFQUFFO1FBQ2pDLE9BQU8sc0RBQXNELENBQUM7S0FDL0Q7U0FBTSxJQUFJLFVBQVUsQ0FBQyxJQUFJLElBQUksSUFBSSxFQUFFO1FBQ2xDLE9BQU8sc0RBQXNELENBQUM7S0FDL0Q7U0FBTSxJQUFJLFVBQVUsQ0FBQyxJQUFJLElBQUksTUFBTSxDQUFDLGdCQUFnQixFQUFFO1FBQ3JELE9BQU8sc0RBQXNELENBQUM7S0FDL0Q7U0FBTTtRQUNMLE9BQU8sc0RBQXNELENBQUM7S0FDL0Q7QUFDSCxDQUFDO0FBRUQsdUJBQXVCLE9BQWdCLEVBQUUsS0FBMEIsRUFBRSxLQUFhO0lBQ2hGLElBQUksUUFBUSxHQUFHLE9BQU8sQ0FBQyxRQUFRLENBQUMsRUFBRSxrQkFBa0IsRUFBRSxJQUFJLEVBQUUsQ0FBQyxDQUFDO0lBQzlELElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUM7SUFDeEIsSUFBSSxPQUFPLENBQUMsSUFBSSxLQUFLLE1BQU0sSUFBSSxPQUFPLENBQUMsVUFBVSxDQUFDLElBQUksSUFBSSxJQUFJLEVBQUU7UUFDOUQsSUFBSSxHQUFHLE9BQU8sQ0FBQyxVQUFVLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQztLQUMzQztTQUFNO1FBQ0wsSUFBSSxHQUFHLElBQUksQ0FBQyxTQUFTLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxDQUFDO0tBQzNDO0lBRUQsSUFBSSxJQUFJLEdBQUc7UUFDVCxFQUFFLEVBQUUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDLEdBQUcsS0FBSyxDQUFDLE1BQU0sR0FBRyxDQUFDLEVBQUU7UUFDMUQsS0FBSyxFQUFFLE9BQU8sQ0FBQyxJQUFJO1FBQ25CLEtBQUssRUFBRSxRQUFRLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQztRQUNuQyxJQUFJO0tBQ0wsQ0FBQztJQUNGLEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7SUFFakIsUUFBUSxDQUFDLE9BQU8sQ0FBQyxDQUFDLEtBQWMsRUFBRSxFQUFFO1FBQ2xDLEtBQUssQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLEVBQUUsYUFBYSxDQUFDLEtBQUssRUFBRSxLQUFLLEVBQUUsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ3pELENBQUMsQ0FBQyxDQUFDO0lBRUgsT0FBTyxJQUFJLENBQUM7QUFDZCxDQUFDO0FBTUQsTUFBTSxDQUFDLE9BQU87SUFDWixNQUFNLENBQUMsUUFBa0IsRUFBRSxVQUEyQixFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUU7UUFDckUsSUFBSSxLQUFLLEdBQXdCLEVBQUUsQ0FBQztRQUNwQyxJQUFJLEtBQUssR0FBVyxFQUFFLENBQUM7UUFDdkIsYUFBYSxDQUFDLElBQUksR0FBRyxDQUFDLFFBQVEsQ0FBQyxDQUFDLFFBQVEsRUFBRSxLQUFLLEVBQUUsS0FBSyxDQUFDLENBQUM7UUFFeEQsSUFBSSxHQUFXLENBQUM7UUFDaEIsSUFBSSxPQUFPLENBQUMsS0FBSyxLQUFLLFFBQVEsSUFBSSxPQUFPLENBQUMsS0FBSyxLQUFLLFNBQVMsRUFBRTtZQUM3RCxHQUFHLEdBQUcsS0FBSyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLEtBQUssSUFBSSxDQUFDLEVBQUUsYUFBYSxJQUFJLENBQUMsS0FBSyxJQUFJLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksRUFBRSxLQUFLLENBQUMsTUFBTSxJQUFJLENBQUMsS0FBSyxJQUFJLENBQUMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsSUFBSTtnQkFDOUgsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsTUFBTSxFQUFFLEtBQUssQ0FBQyxFQUFFLEVBQUUsQ0FBQyxLQUFLLE1BQU0sQ0FBQyxFQUFFLE9BQU8sS0FBSyxDQUFDLEVBQUUsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1NBQ25GO2FBQU07WUFDTCxHQUFHLEdBQUcsS0FBSyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLEtBQUssSUFBSSxDQUFDLEVBQUUsWUFBWSxJQUFJLENBQUMsS0FBSyxNQUFNLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksRUFBRSxLQUFLLENBQUMsS0FBSyxJQUFJLENBQUMsS0FBSyxJQUFJLENBQUMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsSUFBSTtnQkFDOUgsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsTUFBTSxFQUFFLEtBQUssQ0FBQyxFQUFFLEVBQUUsQ0FBQyxLQUFLLE1BQU0sQ0FBQyxFQUFFLE9BQU8sS0FBSyxDQUFDLEVBQUUsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1NBQ25GO1FBRUQsT0FBTztnQkFDSyxPQUFPLENBQUMsS0FBSztFQUMzQixHQUFHO0VBQ0gsQ0FBQztJQUNELENBQUM7Q0FDRiJ9

package.json

 {
   "name": "@atjson/renderer-graphviz",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "Render documents into graphs to help with debugging",
@@ -19,6 +19,6 @@ "main": "dist/commonjs/index.js",
   "dependencies": {
-    "@atjson/document": "0.9.0",
-    "@atjson/hir": "0.9.0"
+    "@atjson/document": "0.11.0",
+    "@atjson/hir": "0.11.0"
   },
-  "gitHead": "8d0640410453bbfc1495644c346145b502cc7400"
+  "gitHead": "36b48214b21591d09269f01d351d805a02447369"
 }

src/index.ts

@@ -1,2 +0,2 @@
-import Document from '@atjson/document';
+import Document, { Annotation } from '@atjson/document';
 import { HIR, HIRNode } from '@atjson/hir';
@@ -7,10 +7,31 @@
   label: string;
+  color: string;
   text: string;
 }
 
+function getColor(annotation: Annotation) {
+  if (annotation.rank === -Infinity) {
+    return 'style=filled fillcolor="#000000" fontcolor="#FFFFFF"';
+  } else if (annotation.rank <= 0) {
+    return 'style=filled fillcolor="#222222" fontcolor="#FFFFFF"';
+  } else if (annotation.rank <= 10) {
+    return 'style=filled fillcolor="#444444" fontcolor="#FFFFFF"';
+  } else if (annotation.rank <= 50) {
+    return 'style=filled fillcolor="#666666" fontcolor="#FFFFFF"';
+  } else if (annotation.rank <= 100) {
+    return 'style=filled fillcolor="#888888" fontcolor="#FFFFFF"';
+  } else if (annotation.rank <= 1000) {
+    return 'style=filled fillcolor="#AAAAAA" fontcolor="#000000"';
+  } else if (annotation.rank <= Number.MAX_SAFE_INTEGER) {
+    return 'style=filled fillcolor="#CCCCCC" fontcolor="#000000"';
+  } else {
+    return 'style=filled fillcolor="#FFFFFF" fontcolor="#000000"';
+  }
+}
+
 function generateGraph(hirNode: HIRNode, edges: Array<[Node, Node]>, nodes: Node[]): Node {
-  let children = hirNode.children();
+  let children = hirNode.children({ includeParseTokens: true });
   let text = hirNode.type;
-  if (hirNode.type === 'text' && hirNode.text != null) {
-    text = hirNode.text;
+  if (hirNode.type === 'text' && hirNode.attributes.text != null) {
+    text = hirNode.annotation.attributes.text;
   } else {
@@ -21,4 +42,5 @@ text = JSON.stringify(hirNode.attributes);
   let node = {
-    id: `${hirNode.type}${nodes.length + 1}`,
+    id: `${hirNode.type.replace('-', '_')}${nodes.length + 1}`,
     label: hirNode.type,
+    color: getColor(hirNode.annotation),
     text
@@ -47,6 +69,6 @@ };
     if (options.shape === 'record' || options.shape === 'Mrecord') {
-      dot = nodes.map(node => `  ${node.id} [label="{${node.label}|${node.text.replace(/"/g, '\\"')}}"];`).join('\n') + '\n' +
+      dot = nodes.map(node => `  ${node.id} [label="{${node.label}|${node.text.replace(/"/g, '\\"')}}" ${node.color}];`).join('\n') + '\n' +
             edges.map(([parent, child]) => `  ${parent.id} -> ${child.id};`).join('\n');
     } else {
-      dot = nodes.map(node => `  ${node.id} [label="${node.label}\\n${node.text.replace(/"/g, '\\"')}"];`).join('\n') + '\n' +
+      dot = nodes.map(node => `  ${node.id} [label="${node.label}\\n${node.text.replace(/"/g, '\\"')}" ${node.color}];`).join('\n') + '\n' +
             edges.map(([parent, child]) => `  ${parent.id} -> ${child.id};`).join('\n');
@@ -53,0 +75,0 @@ }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

59171

increased by24.31%

Lines of code

252

increased by42.37%

Dependency changes

• + Added@atjson/document@0.11.0(transitive)

• + Added@atjson/hir@0.11.0(transitive)

• + Added@types/uuid@3.4.13(transitive)

• + Addeduuid@3.4.0(transitive)

• - Removed@atjson/document@0.9.0(transitive)

• - Removed@atjson/hir@0.9.0(transitive)

• Updated@atjson/document@0.11.0

• Updated@atjson/hir@0.11.0