@atjson/renderer-plain-text - npm Package Compare versions

Comparing version 0.21.41 to 0.22.0

CHANGELOG.md

@@ -6,2 +6,11 @@ # Change Log
 
+# [0.22.0](https://github.com/CondeNast/atjson/compare/@atjson/renderer-plain-text@0.21.41...@atjson/renderer-plain-text@0.22.0) (2020-09-25)
+
+### Features
+
+- add annotations to plain text renderer ([1cb452b](https://github.com/CondeNast/atjson/commit/1cb452ba3f7b7ec29112ece2ca8df077e72efae7))
+- add formatting to plain text renderer ([80be243](https://github.com/CondeNast/atjson/commit/80be2433400cd1b62893a89815910ea0b4495345))
+- add test for rendering line breaks in plain text editor ([398ed72](https://github.com/CondeNast/atjson/commit/398ed7222ae5ba7bd44ec3e316e31c02b965c087))
+- update plain text renderer ([83f54b0](https://github.com/CondeNast/atjson/commit/83f54b0ce6c7a044640937509ffc10a39c797b43))
+
 ## [0.21.41](https://github.com/CondeNast/atjson/compare/@atjson/renderer-plain-text@0.21.40...@atjson/renderer-plain-text@0.21.41) (2020-09-23)
@@ -8,0 +17,0 @@

dist/commonjs/index.d.ts

 import Document from "@atjson/document";
+import { List } from "@atjson/offset-annotations";
 import Renderer from "@atjson/renderer-hir";
@@ -6,3 +7,10 @@ export default class PlainTextRenderer extends Renderer {
     root(): Generator<undefined, any, unknown>;
+    LineBreak(): Generator<never, string, unknown>;
+    Heading(): Generator<undefined, string, unknown>;
+    Blockquote(): Generator<undefined, string, unknown>;
+    Pullquote(): Generator<undefined, string, unknown>;
+    ListItem(): Generator<undefined, any, unknown>;
+    List(annotation: List): Generator<undefined, string, string[]>;
+    Paragraph(): Generator<undefined, string, unknown>;
 }
 //# sourceMappingURL=index.d.ts.map

dist/commonjs/index.js

@@ -10,3 +10,10 @@ "use strict";
         document
-            .where((annotation) => annotation.type !== "parse-token")
+            .where((annotation) => annotation.type !== "parse-token" &&
+            annotation.type !== "line-break" &&
+            annotation.type !== "list-item" &&
+            annotation.type !== "list" &&
+            annotation.type !== "paragraph" &&
+            annotation.type !== "heading" &&
+            annotation.type !== "pullquote" &&
+            annotation.type !== "blockquote")
             .remove();
@@ -19,4 +26,43 @@ super(document, args);
     }
+    *LineBreak() {
+        return "\n";
+    }
+    *Heading() {
+        let item = yield;
+        return item.join("") + "\n\n";
+    }
+    *Blockquote() {
+        let item = yield;
+        return item.join("") + "\n\n";
+    }
+    *Pullquote() {
+        let item = yield;
+        return item.join("") + "\n\n";
+    }
+    *ListItem() {
+        let item = yield;
+        return item.join("");
+    }
+    *List(annotation) {
+        var _a;
+        let items = yield;
+        if (annotation.attributes.type === "bulleted") {
+            items = items.map((item) => {
+                return `- ${item}`;
+            });
+        }
+        else if (annotation.attributes.type === "numbered") {
+            let startsAt = (_a = annotation.attributes.startsAt) !== null && _a !== void 0 ? _a : 1;
+            items = items.map((item, index) => {
+                return `${startsAt + index}. ${item}`;
+            });
+        }
+        return items.join("\n") + "\n\n";
+    }
+    *Paragraph() {
+        let item = yield;
+        return item.join("") + "\n\n";
+    }
 }
 exports.default = PlainTextRenderer;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFDQSx3RUFBNEM7QUFFNUMsTUFBcUIsaUJBQWtCLFNBQVEsc0JBQVE7SUFDckQsWUFBWSxRQUFrQixFQUFFLEdBQUcsSUFBVztRQUM1QyxRQUFRO2FBQ0wsS0FBSyxDQUFDLENBQUMsVUFBc0IsRUFBRSxFQUFFLENBQUMsVUFBVSxDQUFDLElBQUksS0FBSyxhQUFhLENBQUM7YUFDcEUsTUFBTSxFQUFFLENBQUM7UUFDWixLQUFLLENBQUMsUUFBUSxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQ3hCLENBQUM7SUFFRCxDQUFDLElBQUk7UUFDSCxJQUFJLElBQUksR0FBRyxLQUFLLENBQUM7UUFDakIsT0FBTyxJQUFJLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDO0lBQ3ZCLENBQUM7Q0FDRjtBQVpELG9DQVlDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFFQSx3RUFBNEM7QUFFNUMsTUFBcUIsaUJBQWtCLFNBQVEsc0JBQVE7SUFDckQsWUFBWSxRQUFrQixFQUFFLEdBQUcsSUFBVztRQUM1QyxRQUFRO2FBQ0wsS0FBSyxDQUNKLENBQUMsVUFBc0IsRUFBRSxFQUFFLENBRXpCLFVBQVUsQ0FBQyxJQUFJLEtBQUssYUFBYTtZQUNqQyxVQUFVLENBQUMsSUFBSSxLQUFLLFlBQVk7WUFDaEMsVUFBVSxDQUFDLElBQUksS0FBSyxXQUFXO1lBQy9CLFVBQVUsQ0FBQyxJQUFJLEtBQUssTUFBTTtZQUMxQixVQUFVLENBQUMsSUFBSSxLQUFLLFdBQVc7WUFDL0IsVUFBVSxDQUFDLElBQUksS0FBSyxTQUFTO1lBQzdCLFVBQVUsQ0FBQyxJQUFJLEtBQUssV0FBVztZQUMvQixVQUFVLENBQUMsSUFBSSxLQUFLLFlBQVksQ0FDbkM7YUFDQSxNQUFNLEVBQUUsQ0FBQztRQUNaLEtBQUssQ0FBQyxRQUFRLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDeEIsQ0FBQztJQUVELENBQUMsSUFBSTtRQUNILElBQUksSUFBSSxHQUFHLEtBQUssQ0FBQztRQUNqQixPQUFPLElBQUksQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUM7SUFDdkIsQ0FBQztJQUVELENBQUMsU0FBUztRQUNSLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVELENBQUMsT0FBTztRQUNOLElBQUksSUFBSSxHQUFHLEtBQUssQ0FBQztRQUNqQixPQUFPLElBQUksQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLEdBQUcsTUFBTSxDQUFDO0lBQ2hDLENBQUM7SUFFRCxDQUFDLFVBQVU7UUFDVCxJQUFJLElBQUksR0FBRyxLQUFLLENBQUM7UUFDakIsT0FBTyxJQUFJLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxHQUFHLE1BQU0sQ0FBQztJQUNoQyxDQUFDO0lBRUQsQ0FBQyxTQUFTO1FBQ1IsSUFBSSxJQUFJLEdBQUcsS0FBSyxDQUFDO1FBQ2pCLE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsR0FBRyxNQUFNLENBQUM7SUFDaEMsQ0FBQztJQUVELENBQUMsUUFBUTtRQUNQLElBQUksSUFBSSxHQUFHLEtBQUssQ0FBQztRQUNqQixPQUFPLElBQUksQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUM7SUFDdkIsQ0FBQztJQUVELENBQUMsSUFBSSxDQUFDLFVBQWdCOztRQUNwQixJQUFJLEtBQUssR0FBYSxLQUFLLENBQUM7UUFDNUIsSUFBSSxVQUFVLENBQUMsVUFBVSxDQUFDLElBQUksS0FBSyxVQUFVLEVBQUU7WUFDN0MsS0FBSyxHQUFHLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFJLEVBQUUsRUFBRTtnQkFDekIsT0FBTyxLQUFLLElBQUksRUFBRSxDQUFDO1lBQ3JCLENBQUMsQ0FBQyxDQUFDO1NBQ0o7YUFBTSxJQUFJLFVBQVUsQ0FBQyxVQUFVLENBQUMsSUFBSSxLQUFLLFVBQVUsRUFBRTtZQUNwRCxJQUFJLFFBQVEsU0FBRyxVQUFVLENBQUMsVUFBVSxDQUFDLFFBQVEsbUNBQUksQ0FBQyxDQUFDO1lBQ25ELEtBQUssR0FBRyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUMsSUFBSSxFQUFFLEtBQUssRUFBRSxFQUFFO2dCQUNoQyxPQUFPLEdBQUcsUUFBUSxHQUFHLEtBQUssS0FBSyxJQUFJLEVBQUUsQ0FBQztZQUN4QyxDQUFDLENBQUMsQ0FBQztTQUNKO1FBQ0QsT0FBTyxLQUFLLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLE1BQU0sQ0FBQztJQUNuQyxDQUFDO0lBRUQsQ0FBQyxTQUFTO1FBQ1IsSUFBSSxJQUFJLEdBQUcsS0FBSyxDQUFDO1FBQ2pCLE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsR0FBRyxNQUFNLENBQUM7SUFDaEMsQ0FBQztDQUNGO0FBbkVELG9DQW1FQyJ9

dist/modules/index.d.ts

 import Document from "@atjson/document";
+import { List } from "@atjson/offset-annotations";
 import Renderer from "@atjson/renderer-hir";
@@ -6,3 +7,10 @@ export default class PlainTextRenderer extends Renderer {
     root(): Generator<undefined, any, unknown>;
+    LineBreak(): Generator<never, string, unknown>;
+    Heading(): Generator<undefined, string, unknown>;
+    Blockquote(): Generator<undefined, string, unknown>;
+    Pullquote(): Generator<undefined, string, unknown>;
+    ListItem(): Generator<undefined, any, unknown>;
+    List(annotation: List): Generator<undefined, string, string[]>;
+    Paragraph(): Generator<undefined, string, unknown>;
 }
 //# sourceMappingURL=index.d.ts.map

dist/modules/index.js

@@ -5,3 +5,10 @@ import Renderer from "@atjson/renderer-hir";
         document
-            .where((annotation) => annotation.type !== "parse-token")
+            .where((annotation) => annotation.type !== "parse-token" &&
+            annotation.type !== "line-break" &&
+            annotation.type !== "list-item" &&
+            annotation.type !== "list" &&
+            annotation.type !== "paragraph" &&
+            annotation.type !== "heading" &&
+            annotation.type !== "pullquote" &&
+            annotation.type !== "blockquote")
             .remove();
@@ -14,3 +21,42 @@ super(document, args);
     }
+    *LineBreak() {
+        return "\n";
+    }
+    *Heading() {
+        let item = yield;
+        return item.join("") + "\n\n";
+    }
+    *Blockquote() {
+        let item = yield;
+        return item.join("") + "\n\n";
+    }
+    *Pullquote() {
+        let item = yield;
+        return item.join("") + "\n\n";
+    }
+    *ListItem() {
+        let item = yield;
+        return item.join("");
+    }
+    *List(annotation) {
+        var _a;
+        let items = yield;
+        if (annotation.attributes.type === "bulleted") {
+            items = items.map((item) => {
+                return `- ${item}`;
+            });
+        }
+        else if (annotation.attributes.type === "numbered") {
+            let startsAt = (_a = annotation.attributes.startsAt) !== null && _a !== void 0 ? _a : 1;
+            items = items.map((item, index) => {
+                return `${startsAt + index}. ${item}`;
+            });
+        }
+        return items.join("\n") + "\n\n";
+    }
+    *Paragraph() {
+        let item = yield;
+        return item.join("") + "\n\n";
+    }
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxRQUFRLE1BQU0sc0JBQXNCLENBQUM7QUFFNUMsTUFBTSxDQUFDLE9BQU8sT0FBTyxpQkFBa0IsU0FBUSxRQUFRO0lBQ3JELFlBQVksUUFBa0IsRUFBRSxHQUFHLElBQVc7UUFDNUMsUUFBUTthQUNMLEtBQUssQ0FBQyxDQUFDLFVBQXNCLEVBQUUsRUFBRSxDQUFDLFVBQVUsQ0FBQyxJQUFJLEtBQUssYUFBYSxDQUFDO2FBQ3BFLE1BQU0sRUFBRSxDQUFDO1FBQ1osS0FBSyxDQUFDLFFBQVEsRUFBRSxJQUFJLENBQUMsQ0FBQztJQUN4QixDQUFDO0lBRUQsQ0FBQyxJQUFJO1FBQ0gsSUFBSSxJQUFJLEdBQUcsS0FBSyxDQUFDO1FBQ2pCLE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUN2QixDQUFDO0NBQ0YifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBRUEsT0FBTyxRQUFRLE1BQU0sc0JBQXNCLENBQUM7QUFFNUMsTUFBTSxDQUFDLE9BQU8sT0FBTyxpQkFBa0IsU0FBUSxRQUFRO0lBQ3JELFlBQVksUUFBa0IsRUFBRSxHQUFHLElBQVc7UUFDNUMsUUFBUTthQUNMLEtBQUssQ0FDSixDQUFDLFVBQXNCLEVBQUUsRUFBRSxDQUV6QixVQUFVLENBQUMsSUFBSSxLQUFLLGFBQWE7WUFDakMsVUFBVSxDQUFDLElBQUksS0FBSyxZQUFZO1lBQ2hDLFVBQVUsQ0FBQyxJQUFJLEtBQUssV0FBVztZQUMvQixVQUFVLENBQUMsSUFBSSxLQUFLLE1BQU07WUFDMUIsVUFBVSxDQUFDLElBQUksS0FBSyxXQUFXO1lBQy9CLFVBQVUsQ0FBQyxJQUFJLEtBQUssU0FBUztZQUM3QixVQUFVLENBQUMsSUFBSSxLQUFLLFdBQVc7WUFDL0IsVUFBVSxDQUFDLElBQUksS0FBSyxZQUFZLENBQ25DO2FBQ0EsTUFBTSxFQUFFLENBQUM7UUFDWixLQUFLLENBQUMsUUFBUSxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQ3hCLENBQUM7SUFFRCxDQUFDLElBQUk7UUFDSCxJQUFJLElBQUksR0FBRyxLQUFLLENBQUM7UUFDakIsT0FBTyxJQUFJLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDO0lBQ3ZCLENBQUM7SUFFRCxDQUFDLFNBQVM7UUFDUixPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRCxDQUFDLE9BQU87UUFDTixJQUFJLElBQUksR0FBRyxLQUFLLENBQUM7UUFDakIsT0FBTyxJQUFJLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxHQUFHLE1BQU0sQ0FBQztJQUNoQyxDQUFDO0lBRUQsQ0FBQyxVQUFVO1FBQ1QsSUFBSSxJQUFJLEdBQUcsS0FBSyxDQUFDO1FBQ2pCLE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsR0FBRyxNQUFNLENBQUM7SUFDaEMsQ0FBQztJQUVELENBQUMsU0FBUztRQUNSLElBQUksSUFBSSxHQUFHLEtBQUssQ0FBQztRQUNqQixPQUFPLElBQUksQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLEdBQUcsTUFBTSxDQUFDO0lBQ2hDLENBQUM7SUFFRCxDQUFDLFFBQVE7UUFDUCxJQUFJLElBQUksR0FBRyxLQUFLLENBQUM7UUFDakIsT0FBTyxJQUFJLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDO0lBQ3ZCLENBQUM7SUFFRCxDQUFDLElBQUksQ0FBQyxVQUFnQjs7UUFDcEIsSUFBSSxLQUFLLEdBQWEsS0FBSyxDQUFDO1FBQzVCLElBQUksVUFBVSxDQUFDLFVBQVUsQ0FBQyxJQUFJLEtBQUssVUFBVSxFQUFFO1lBQzdDLEtBQUssR0FBRyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUMsSUFBSSxFQUFFLEVBQUU7Z0JBQ3pCLE9BQU8sS0FBSyxJQUFJLEVBQUUsQ0FBQztZQUNyQixDQUFDLENBQUMsQ0FBQztTQUNKO2FBQU0sSUFBSSxVQUFVLENBQUMsVUFBVSxDQUFDLElBQUksS0FBSyxVQUFVLEVBQUU7WUFDcEQsSUFBSSxRQUFRLFNBQUcsVUFBVSxDQUFDLFVBQVUsQ0FBQyxRQUFRLG1DQUFJLENBQUMsQ0FBQztZQUNuRCxLQUFLLEdBQUcsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksRUFBRSxLQUFLLEVBQUUsRUFBRTtnQkFDaEMsT0FBTyxHQUFHLFFBQVEsR0FBRyxLQUFLLEtBQUssSUFBSSxFQUFFLENBQUM7WUFDeEMsQ0FBQyxDQUFDLENBQUM7U0FDSjtRQUNELE9BQU8sS0FBSyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsR0FBRyxNQUFNLENBQUM7SUFDbkMsQ0FBQztJQUVELENBQUMsU0FBUztRQUNSLElBQUksSUFBSSxHQUFHLEtBQUssQ0FBQztRQUNqQixPQUFPLElBQUksQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLEdBQUcsTUFBTSxDQUFDO0lBQ2hDLENBQUM7Q0FDRiJ9

package.json

 {
   "name": "@atjson/renderer-plain-text",
-  "version": "0.21.41",
+  "version": "0.22.0",
   "description": "Render atjson documents in plain text",
@@ -17,2 +17,3 @@ "main": "dist/commonjs/index.js",
   "dependencies": {
+    "@atjson/offset-annotations": "0.33.0",
     "@atjson/renderer-hir": "0.22.9"
@@ -23,3 +24,3 @@ },
   },
-  "gitHead": "fb4c4e83527af2a2869bb35ddf172bfca218304e"
+  "gitHead": "5d1a6efc81063435eebb22652d46b26bd7e8c594"
 }

No alert changes

Improved metrics

Total package byte prevSize

504947

increased by28.61%

Lines of code

160

increased by207.69%

Worsened metrics

Dependency count

3

increased by50%

Dependency changes

• + Added@atjson/offset-annotations@0.33.0

• + Added@atjson/offset-annotations@0.33.0(transitive)