kni 4.0.3 → 5.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Kris Kowal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -29,7 +29,7 @@ Use npm to install and run kni. The kni command line requires Node.js version 4
 or greater. Use a major version of kni explicitly.
 
 ```
-$ npm install kni@3
+$ npm install kni@4
 $ PATH=$(pwd)/node_modules/.bin:$PATH
 $ kni
 ```
@@ -82,16 +82,16 @@ $ open hello.html
 - [Peruácru][peruacru] is an app for iOS and Android using Apache Cordova.
   A [slice](https://github.com/kriskowal/peruacru.then.land) of the game is open source for illustration.
 
-  [![Peruácru Icon](https://github.com/kriskowal/kni/raw/master/examples/peruacru.png)][peruacru]
+  [![Peruácru Icon](examples/peruacru.png)][peruacru]
 
 - The [archery][] prototype illustrates a shop and gambling game.
 
-  [![An Archery Shop](https://github.com/kriskowal/kni/raw/master/examples/archery.png)][archery]
+  [![An Archery Shop](examples/archery.png)][archery]
 
 - The [journey][] prototype illustrates a survival game over a
   procedurally-generated infinite road.
 
-  [![A Journey through Ælfland](https://github.com/kriskowal/kni/raw/master/examples/journey.png)][journey]
+  [![A Journey through Ælfland](examples/journey.png)][journey]
 
 - The [airship][] prototype illustrates a narrative that includes
   a simulation of the control and behavior of a steampunk airship.
@@ -131,12 +131,12 @@ The command line tool can also:
   $ kni -J hello.json
   ```
 
-- Kni can also produce a diagnostique view of a story. The first column is
+- Kni can also produce a diagnostic view of a story. The first column is
   the thread label, then the instruction type, a description of the
-  instruction, and an indicator for the next thread. In the absense of an
+  instruction, and an indicator for the next thread. In the absence of an
   indicator, the engine proceeds to the next instruction. A forward arrow
   indicates a jump and a backward arrow indicates a return to a calling thread,
-  a processsion to the next thread of a question or answer sequence, or an
+  a procession to the next thread of a question or answer sequence, or an
   exit.
 
   ```
@@ -162,3 +162,5 @@ DON’T PANIC
 
 Copyright © 2016 by Kristopher Kowal.
 All rights reserved.
+
+[![Coverage Status](https://coveralls.io/repos/github/borkshop/kni/badge.svg)](https://coveralls.io/github/borkshop/kni)

package/console.js

@@ -1,63 +1,61 @@
-'use strict';
+import Excerpt from './excerpt.js';
+import Wrapper from './wrapper.js';
 
-module.exports = Console;
-
-var Excerpt = require('./excerpt');
-var Wrapper = require('./wrapper');
-
-function Console(writer) {
+export default class Console {
+  constructor(writer) {
     this.writer = writer;
     this.wrapper = new Wrapper(writer);
     this.excerpt = new Excerpt();
     this.options = [];
     this.cursor = this.excerpt;
-}
+  }
 
-Console.prototype.write = function write(lift, text, drop) {
+  write(lift, text, drop) {
     this.cursor.digest(lift, text, drop);
-};
+  }
 
-Console.prototype.break = function _break() {
+  break() {
     this.cursor.break();
-};
+  }
 
-Console.prototype.paragraph = function paragraph() {
+  paragraph() {
     this.cursor.paragraph();
-};
+  }
 
-Console.prototype.startOption = function startOption() {
-    var option = new Excerpt();
+  startOption() {
+    const option = new Excerpt();
     this.cursor = option;
     this.options.push(option);
-};
+  }
 
-Console.prototype.stopOption = function stopOption() {
+  stopOption() {
     this.cursor = this.excerpt;
-};
+  }
 
-Console.prototype.flush = function flush() {
+  flush() {
     this.writer.write('\n');
-};
+  }
 
-Console.prototype.pardon = function pardon() {
+  pardon() {
     this.writer.write('?\n');
-};
+  }
 
-Console.prototype.display = function display() {
+  display() {
     this.excerpt.write(this.wrapper);
-    for (var i = 0; i < this.options.length; i++) {
-        var number = i + 1;
-        var lead = (number + '.   ').slice(0, 3) + ' ';
-        this.wrapper.word(lead);
-        this.wrapper.flush = true;
-        this.wrapper.push('    ', '   ');
-        this.options[i].write(this.wrapper);
-        this.wrapper.pop();
+    for (let i = 0; i < this.options.length; i++) {
+      const number = i + 1;
+      const lead = `${`${number}.   `.slice(0, 3)} `;
+      this.wrapper.word(lead);
+      this.wrapper.flush = true;
+      this.wrapper.push('    ', '   ');
+      this.options[i].write(this.wrapper);
+      this.wrapper.pop();
     }
-};
+  }
 
-Console.prototype.clear = function clear() {
+  clear() {
     this.excerpt = new Excerpt();
     this.options = [];
     this.cursor = this.excerpt;
-};
+  }
+}

package/describe.js

@@ -1,116 +1,81 @@
-'use strict';
+const types = {};
 
-module.exports = describe;
+const describe = node => {
+  return types[node.type](node);
+};
 
-function describe(node) {
-    return types[node.type](node);
-}
+export default describe;
 
-var types = {};
+types.text = node => node.text;
 
-types.text = function text(node) {
-    return node.text;
-};
+types.echo = node => S(node.expression);
 
-types.echo = function echo(node) {
-    return S(node.expression);
-};
+types.opt = node => `(Q ${node.question.join(' ')}) (A ${node.answer.join(' ')})`;
 
-types.opt = function opt(node) {
-    return '(Q ' + node.question.join(' ') + ') (A ' + node.answer.join(' ') + ')';
-};
+types.goto = _node => '';
 
-types.goto = function goto(node) {
-    return '';
-};
+types.call = node => `${node.label}(${node.args.map(S).join(' ')}) esc ${node.branch}`;
 
-types.call = function call(node) {
-    return node.label + '(' + node.args.map(S).join(' ') + ') esc ' + node.branch;
-};
+types.def = node => `(${node.locals.join(' ')})`;
 
-types.def = function def(node) {
-    return '(' + node.locals.join(' ') + ')';
-};
+types.jump = node => `${node.branch} if ${S(node.condition)}`;
 
-types.jump = function jump(node) {
-    return node.branch + ' if ' + S(node.condition);
+types.switch = node => {
+  let desc = '';
+  if (node.variable) {
+    desc += `(${node.variable}+${node.value}) ${S(node.expression)}`;
+  } else {
+    desc += S(node.expression);
+  }
+  desc += ` (${node.branches.join(' ')}) W(${node.weights.map(S).join(' ')})`;
+  return desc;
 };
 
-types.switch = function _switch(node) {
-    var desc = '';
-    if (node.variable) {
-        desc += '(' + node.variable + '+' +  node.value + ') ' + S(node.expression);
-    } else {
-        desc += S(node.expression);
-    }
-    desc += ' (' + node.branches.join(' ') + ') W(' + node.weights.map(S).join(' ') + ')';
-    return desc;
-};
+types.set = node => `${node.variable} ${S(node.expression)}`;
 
-types.set = function set(node) {
-    return node.variable + ' ' + S(node.expression);
-};
+types.move = node => `${S(node.source)} -> ${S(node.target)}`;
 
-types.move = function move(node) {
-    return S(node.source) + ' -> ' + S(node.target);
-};
+types.cue = node => node.cue;
 
-types.cue = function cue(node) {
-    return node.cue;
-};
+types.br = _node => '';
 
-types.br = function br(node) {
-    return '';
-};
+types.par = _node => '';
 
-types.par = function par(node) {
-    return '';
-};
+types.rule = _node => '';
 
-types.rule = function rule(node) {
-    return '';
-};
+types.startJoin = _node => '';
 
-types.startJoin = function startJoin(node) {
-    return '';
-};
+types.stopJoin = _node => '';
 
-types.stopJoin = function stopJoin(node) {
-    return '';
-};
+types.delimit = _node => '';
 
-types.delimit = function delimit(node) {
-    return '';
-};
+types.ask = _node => '';
 
-types.ask = function ask(node) {
-    return '';
+types.read = node => {
+  let label = node.variable;
+  if (node.cue != null) {
+    label += ` ${node.cue}`;
+  }
+  return label;
 };
 
-types.read = function ask(node) {
-    var label = node.variable;
-    if (node.cue != null) {
-        label += ' ' + node.cue;
-    }
-    return label;
+const S = args => {
+  if (args[0] === 'val' || args[0] === 'get') {
+    return args[1];
+  } else if (args[0] === 'var') {
+    return `(${args[0]} ${V(args[1], args[2])})`;
+  } else {
+    return `(${args[0]} ${args.slice(1).map(S).join(' ')})`;
+  }
 };
 
-function S(args) {
-    if (args[0] === 'val' || args[0] === 'get') {
-        return args[1];
-    } else if (args[0] === 'var') {
-        return '(' + args[0] + ' ' + V(args[1], args[2]) + ')';
-    } else {
-        return '(' + args[0] + ' ' + args.slice(1).map(S).join(' ') + ')';
-    }
-}
-
-function V(source, target) {
-    var r = '';
-    for (var i = 0; i < target.length; i++) {
-        r += source[i];
-        r += '{' + S(target[i]) + '}';
-    }
+const V = (source, target) => {
+  let r = '';
+  let i;
+  for (i = 0; i < target.length; i++) {
     r += source[i];
-    return r;
-}
+    r += `{${S(target[i])}}`;
+  }
+  r += source[i];
+  return r;
+};

package/document.js

@@ -1,9 +1,14 @@
-'use strict';
+const linkMatcher = /\s*(\w+:\/\/\S+)$/;
 
-module.exports = Document;
+export default class Document {
+  constructor(element, options = {}) {
+    const {
+      createPage = undefined,
+      meterFaultButton = undefined,
+      pageTurnBehavior = 'log',
+    } = options;
 
-function Document(element, createPage) {
-    var self = this;
+    const self = this;
     this.document = element.ownerDocument;
     this.parent = element;
     this.frame = null;
@@ -19,92 +24,114 @@ function Document(element, createPage) {
     this.options = null;
     this.p = false;
     this.br = false;
-    this.onclick = onclick;
+    this.onclick = event => {
+      self.answer(event.target.number);
+    };
     this.createPage = createPage || this.createPage;
-    function onclick(event) {
-        self.answer(event.target.number);
-    }
+    this.meterFaultButton = meterFaultButton;
+    this.pageTurnBehavior = pageTurnBehavior;
+
     Object.seal(this);
-}
+  }
 
-Document.prototype.write = function write(lift, text, drop) {
-    var document = this.document;
+  write(lift, text, drop) {
+    const document = this.document;
     lift = this.carry || lift;
     if (this.p) {
-        this.cursor = document.createElement("p");
-        this.cursorParent.insertBefore(this.cursor, this.afterCursor);
-        this.p = false;
-        this.br = false;
-        lift = '';
+      this.cursor = document.createElement('p');
+      this.cursorParent.insertBefore(this.cursor, this.afterCursor);
+      this.p = false;
+      this.br = false;
+      lift = '';
     }
     if (this.br) {
-        this.cursor.appendChild(document.createElement("br"));
-        this.br = false;
-        lift = '';
+      this.cursor.appendChild(document.createElement('br'));
+      this.br = false;
+      lift = '';
+    }
+    const match = linkMatcher.exec(text);
+    if (match === null) {
+        // TODO merge with prior text node
+        this.cursor.appendChild(document.createTextNode(lift + text));
+    } else {
+        // Support a hyperlink convention.
+        if (lift !== '') {
+            this.cursor.appendChild(document.createTextNode(lift));
+        }
+        const link = document.createElement('a');
+        link.href = match[1];
+        link.target = '_blank';
+        link.rel = 'noreferrer';
+        link.appendChild(document.createTextNode(text.slice(0, match.index)));
+        this.cursor.appendChild(link);
     }
-    // TODO merge with prior text node
-    this.cursor.appendChild(document.createTextNode(lift + text));
     this.carry = drop;
-};
+  }
 
-Document.prototype.break = function _break() {
+  break() {
     this.br = true;
-};
+  }
 
-Document.prototype.paragraph = function paragraph() {
+  paragraph() {
     this.p = true;
-};
+  }
 
-Document.prototype.startOption = function startOption() {
+  startOption() {
     this.optionIndex++;
-    var document = this.document;
-    var tr = document.createElement("tr");
+    const document = this.document;
+    const tr = document.createElement('tr');
     this.options.appendChild(tr);
-    var th = document.createElement("th");
+    const th = document.createElement('th');
     tr.appendChild(th);
-    th.innerText = this.optionIndex + '.';
-    var td = document.createElement("td");
+    th.innerText = `${this.optionIndex}.`;
+    const td = document.createElement('td');
     td.number = this.optionIndex;
     td.onclick = this.onclick;
-    td.setAttribute("aria-role", "button");
+    td.setAttribute('aria-role', 'button');
     tr.appendChild(td);
     this.cursor = td;
     this.p = false;
     this.br = false;
     this.carry = '';
-};
+  }
 
-Document.prototype.stopOption = function stopOption() {
+  stopOption() {
     this.p = false;
     this.br = false;
-};
+  }
 
-Document.prototype.flush = function flush() {
+  flush() {
     // No-op (for console only)
-};
+  }
 
-Document.prototype.pardon = function pardon() {
+  pardon() {
     // No-op (for console only)
-};
+  }
 
-Document.prototype.display = function display() {
+  display() {
     this.frame.style.opacity = 0;
     this.frame.style.transform = 'translateX(2ex)';
     this.parent.appendChild(this.frame);
 
     // TODO not this
-    var frame = this.frame;
-    setTimeout(function () {
-        frame.style.opacity = 1;
-        frame.style.transform = 'translateX(0)';
+    const frame = this.frame;
+    setTimeout(() => {
+      frame.style.opacity = 1;
+      frame.style.transform = 'translateX(0)';
     }, 10);
-};
+  }
 
-Document.prototype.clear = function clear() {
+  clear() {
     if (this.frame) {
+      if (this.pageTurnBehavior === 'log') {
+        this.options.remove();
+      } else if (this.pageTurnBehavior === 'remove') {
+        this.frame.remove();
+      } else if (this.pageTurnBehavior === 'fade') {
         this.frame.style.opacity = 0;
         this.frame.style.transform = 'translateX(-2ex)';
-        this.frame.addEventListener("transitionend", this);
+        this.frame.addEventListener('transitionend', this);
+      }
     }
     this.createPage(this.document, this);
     this.cursor = null;
@@ -114,46 +141,50 @@ Document.prototype.clear = function clear() {
     this.p = true;
     this.carry = '';
     this.optionIndex = 0;
-};
+  }
 
-Document.prototype.createPage = function createPage(document) {
-    this.frame = document.createElement("div");
-    this.frame.classList.add("kni-frame");
+  createPage(document) {
+    this.frame = document.createElement('div');
+    this.frame.classList.add('kni-frame');
     this.frame.style.opacity = 0;
 
-    var A = document.createElement("div");
-    A.classList.add("kni-frame-a");
+    const A = document.createElement('div');
+    A.classList.add('kni-frame-a');
     this.frame.appendChild(A);
 
-    var B = document.createElement("div");
-    B.classList.add("kni-frame-b");
+    const B = document.createElement('div');
+    B.classList.add('kni-frame-b');
     A.appendChild(B);
 
-    var C = document.createElement("div");
-    C.classList.add("kni-frame-c");
+    const C = document.createElement('div');
+    C.classList.add('kni-frame-c');
     B.appendChild(C);
 
-    this.body = document.createElement("div");
-    this.body.classList.add("kni-body");
+    this.body = document.createElement('div');
+    this.body.classList.add('kni-body');
     C.appendChild(this.body);
 
-    this.options = document.createElement("table");
+    this.options = document.createElement('table');
     this.body.appendChild(this.options);
     this.afterBody = this.options;
-};
+  }
+
+  handleEvent(event) {
+    // transitionend on this.frame, only
+    event.target.remove();
+  }
 
-Document.prototype.handleEvent = function handleEvent(event) {
-    if (event.target.parentNode === this.parent) {
-        this.parent.removeChild(event.target);
+  meterFault() {
+    if (this.meterFaultButton) {
+      this.body.appendChild(this.meterFaultButton);
     }
-};
+  }
 
-Document.prototype.ask = function ask(cue) {
-};
+  ask(_cue) {}
 
-Document.prototype.answer = function answer(text) {
+  answer(text) {
     this.engine.answer(text);
-};
+  }
 
-Document.prototype.close = function close() {
-};
+  close() {}
+}