console-toolkit 1.0.0

package/src/themes/lines/unicode-rounded.js

@@ -0,0 +1,15 @@
+import {populateTheme} from '../utils.js';
+
+export const lineTheme = {};
+
+const table11 = {t: '╭┬╮', m: '├┼┤', b: '╰┴╯', v: '│││', h: '───'},
+  table12 = {t: '╓╥╖', m: '╟╫╢', b: '╙╨╜', v: '║║║', h: '───'},
+  table21 = {t: '╒╤╕', m: '╞╪╡', b: '╘╧╛', v: '│││', h: '═══'},
+  table22 = {t: '╔╦╗', m: '╠╬╣', b: '╚╩╝', v: '║║║', h: '═══'};
+
+populateTheme(lineTheme, table11, 1, 1);
+populateTheme(lineTheme, table12, 1, 2);
+populateTheme(lineTheme, table21, 2, 1);
+populateTheme(lineTheme, table22, 2, 2);
+
+export default lineTheme;

package/src/themes/lines/unicode.js

@@ -0,0 +1,15 @@
+import {populateTheme} from '../utils.js';
+
+export const lineTheme = {};
+
+const table11 = {t: '┌┬┐', m: '├┼┤', b: '└┴┘', v: '│││', h: '───'},
+  table12 = {t: '╓╥╖', m: '╟╫╢', b: '╙╨╜', v: '║║║', h: '───'},
+  table21 = {t: '╒╤╕', m: '╞╪╡', b: '╘╧╛', v: '│││', h: '═══'},
+  table22 = {t: '╔╦╗', m: '╠╬╣', b: '╚╩╝', v: '║║║', h: '═══'};
+
+populateTheme(lineTheme, table11, 1, 1);
+populateTheme(lineTheme, table12, 1, 2);
+populateTheme(lineTheme, table21, 2, 1);
+populateTheme(lineTheme, table22, 2, 2);
+
+export default lineTheme;

package/src/themes/utils.js

@@ -0,0 +1,38 @@
+// A table definition matrix should define the following properties:
+//   - 't': top row (3 symbols),
+//   - 'm': middle row (3 symbols),
+//   - 'b': bottom row (3 symbols),
+//   - 'v': vertical separators (3 symbols) - left border, internal, right border,
+//   - 'h': horizontal separators (3 symbol) - top border, internal, bottom border,
+//   - 'w': (optional) width of individual t/m/b/v symbols.
+// t/m/b/v lines should have the same width for each symbol.
+// h should have 3 symbols of length 1.
+
+// The default value for 'w': 1
+
+export const populateTheme = (lineTheme, tableDefinition, hTheme, vTheme) => {
+  const w = tableDefinition.w || 1,
+    s = [0, w, w << 1],
+    e = [s[0] + w, s[1] + w, s[2] + w],
+    theme = (lineTheme['t_' + hTheme + '_' + vTheme] = [
+      tableDefinition.m.substring(s[1], e[1]),
+      tableDefinition.t.substring(s[1], e[1]), // before
+      tableDefinition.b.substring(s[1], e[1]), // after
+      tableDefinition.h[1].repeat(w),
+      tableDefinition.m.substring(s[0], e[0]),
+      tableDefinition.t.substring(s[0], e[0]), // before
+      tableDefinition.b.substring(s[0], e[0]), // after
+      tableDefinition.h[0].repeat(w),
+      tableDefinition.m.substring(s[2], e[2]),
+      tableDefinition.t.substring(s[2], e[2]), // before
+      tableDefinition.b.substring(s[2], e[2]), // after
+      tableDefinition.h[2].repeat(w),
+      tableDefinition.v.substring(s[1], e[1]),
+      tableDefinition.v.substring(s[0], e[0]), // before
+      tableDefinition.v.substring(s[2], e[2]) // after
+    ]);
+  lineTheme['h_' + hTheme] = [tableDefinition.h[1], tableDefinition.h[0], tableDefinition.h[2]];
+  lineTheme['v_' + vTheme] = theme.slice(12);
+  lineTheme['w_' + vTheme] = w;
+  lineTheme.f = tableDefinition.f || ' ';
+};

package/src/turtle/draw-line-art.js

@@ -0,0 +1,46 @@
+import Box from '../box.js';
+
+const BEFORE = 1,
+  AFTER = 2,
+  BOTH = 3;
+
+const getIndex = cell => {
+  if (!cell) return {skipFlag: true};
+
+  const hTheme = cell.l || cell.r,
+    vTheme = cell.u || cell.d,
+    hIndex = (cell.l ? 0 : BEFORE) | (cell.r ? 0 : AFTER),
+    vIndex = (cell.u ? 0 : BEFORE) | (cell.d ? 0 : AFTER),
+    skipFlag = hIndex == BOTH && vIndex == BOTH;
+  return {skipFlag, hTheme, vTheme, hIndex, vIndex};
+};
+
+export const draw = (turtle, lineTheme, {ignore = ' '} = {}) =>
+  new Box(
+    turtle.cells.map(row =>
+      row
+        .map(cell => {
+          const {skipFlag, hTheme, vTheme, hIndex, vIndex} = getIndex(cell);
+          if (skipFlag) return ignore;
+          if (!hTheme) {
+            if (lineTheme['w_' + vTheme] !== 1)
+              throw new TypeError(`Vertical theme "${vTheme}" should have width of 1 for all vertical elements`);
+            if (!lineTheme['v_' + vTheme]) throw new TypeError(`Style has no "v_${vTheme}" property`);
+            return lineTheme['v_' + vTheme][vIndex];
+          }
+          if (!vTheme) {
+            if (!lineTheme['h_' + hTheme]) throw new TypeError(`Style has no "h_${hTheme}" property`);
+            return lineTheme['h_' + hTheme][hIndex];
+          }
+          if (lineTheme['w_' + vTheme] !== 1)
+            throw new TypeError(`Vertical theme "${vTheme}" should have width of 1 for all vertical elements`);
+          if (!lineTheme['t_' + hTheme + '_' + vTheme])
+            throw new TypeError(`Style has no "t_${hTheme}_${vTheme}" property`);
+          return lineTheme['t_' + hTheme + '_' + vTheme][4 * hIndex + vIndex];
+        })
+        .join('')
+    ),
+    true
+  );
+
+export default draw;

package/src/turtle/draw-unicode.js

@@ -0,0 +1,33 @@
+import Box from '../box.js';
+
+const symbols =
+  ' ╵╹╶└┖╺┕┗' +
+  '╷│╿┌├┞┍┝┡' +
+  '╻╽┃┎┟┠┏┢┣' +
+  '╴┘┚─┴┸╼┶┺' +
+  '┐┤┦┬┼╀┮┾╄' +
+  '┒┧┨┰╁╂┲╆╊' +
+  '╸┙┛╾┵┹━┷┻' +
+  '┑┥┩┭┽╃┯┿╇' +
+  '┓┪┫┱╅╉┳╈╋';
+
+const arcs = {4: '╰', 12: '╭', 28: '╯', 36: '╮'};
+
+const getIndex = cell => (cell ? (((+cell.l || 0) * 3 + (+cell.d || 0)) * 3 + (+cell.r || 0)) * 3 + (+cell.u || 0) : 0);
+
+export const draw = (turtle, {ignore = ' ', useArcs} = {}) =>
+  new Box(
+    turtle.cells.map(row =>
+      row
+        .map(cell => {
+          const index = getIndex(cell);
+          if (isNaN(index) || index < 0 || index >= symbols.length)
+            throw new Error('Wrong theme. It can be either 1 or 2');
+          return index ? (useArcs ? arcs[index] || symbols[index] : symbols[index]) : ignore;
+        })
+        .join('')
+    ),
+    true
+  );
+
+export default draw;

package/src/turtle/index.js

@@ -0,0 +1,12 @@
+import Turtle from './turtle.js';
+import draw from './draw-unicode.js';
+
+Turtle.prototype.toBox = function (options) {
+  return draw(this, options);
+};
+Turtle.prototype.toStrings = function (options) {
+  return this.toBox(options).toStrings();
+};
+
+export {Turtle, draw};
+export default Turtle;

package/src/turtle/turtle.js

@@ -0,0 +1,286 @@
+import {addAliases} from '../meta.js';
+
+export class Turtle {
+  static RIGHT = 0;
+  static DOWN = 1;
+  static LEFT = 2;
+  static UP = 3;
+
+  static EAST = 0;
+  static SOUTH = 1;
+  static WEST = 2;
+  static NORTH = 3;
+
+  constructor(width, height, theme = 1) {
+    this.cells = new Array(height);
+    for (let i = 0; i < height; ++i) {
+      this.cells[i] = new Array(width).fill(null);
+    }
+
+    this.width = width;
+    this.height = height;
+    this.direction = Turtle.RIGHT;
+    this.position = {x: 0, y: 0};
+    this.theme = theme;
+    this.stack = [];
+  }
+
+  reset() {
+    this.position.x = this.position.y = 0;
+    return this;
+  }
+  set(x, y) {
+    this.position.x = Math.max(0, Math.min(this.width - 1, x));
+    this.position.y = Math.max(0, Math.min(this.height - 1, y));
+    return this;
+  }
+  setX(x) {
+    this.position.x = Math.max(0, Math.min(this.width - 1, x));
+    return this;
+  }
+  setY(y) {
+    this.position.y = Math.max(0, Math.min(this.height - 1, y));
+    return this;
+  }
+  add(dx, dy) {
+    return this.set(x + dx, y + dy);
+  }
+  addX(dx) {
+    return this.setX(x + dx);
+  }
+  addY(dy) {
+    return this.setY(y + dy);
+  }
+
+  setTheme(theme) {
+    this.theme = theme;
+    return this;
+  }
+
+  setDirection(direction) {
+    this.direction = direction % 4;
+    return this;
+  }
+  setUp() {
+    return this.setDirection(Turtle.UP);
+  }
+  setDown() {
+    return this.setDirection(Turtle.DOWN);
+  }
+  setLeft() {
+    return this.setDirection(Turtle.LEFT);
+  }
+  setRight() {
+    return this.setDirection(Turtle.RIGHT);
+  }
+  left() {
+    return this.setDirection((this.direction + 3) % 4);
+  }
+  right() {
+    return this.setDirection((this.direction + 1) % 4);
+  }
+
+  save() {
+    this.stack.push([this.position.x, this.position.y, this.direction, this.theme]);
+    return this;
+  }
+  restore() {
+    if (!this.stack) throw new ReferenceError('Unmatched restore');
+    [this.position.x, this.position.y, this.direction, this.theme] = this.stack.pop();
+    return this;
+  }
+
+  moveUp(distance) {
+    if (!distance) return this;
+    if (distance < 0) return this.moveDown(-distance);
+
+    const last = Math.max(0, this.position.y - distance);
+    if (this.position.y === last) return this;
+
+    for (let i = this.position.y; i >= last; --i) {
+      let cell = this.cells[i][this.position.x];
+      if (!cell) cell = this.cells[i][this.position.x] = {};
+      switch (i) {
+        case this.position.y:
+          cell.u = this.theme;
+          break;
+        case last:
+          cell.d = this.theme;
+          break;
+        default:
+          cell.u = cell.d = this.theme;
+          break;
+      }
+    }
+
+    this.position.y = last;
+    return this;
+  }
+  moveDown(distance) {
+    if (!distance) return this;
+    if (distance < 0) return this.moveUp(-distance);
+
+    const last = Math.min(this.height - 1, this.position.y + distance);
+    if (this.position.y === last) return this;
+
+    for (let i = this.position.y; i <= last; ++i) {
+      let cell = this.cells[i][this.position.x];
+      if (!cell) cell = this.cells[i][this.position.x] = {};
+      switch (i) {
+        case this.position.y:
+          cell.d = this.theme;
+          break;
+        case last:
+          cell.u = this.theme;
+          break;
+        default:
+          cell.u = cell.d = this.theme;
+          break;
+      }
+    }
+
+    this.position.y = last;
+    return this;
+  }
+  moveLeft(distance) {
+    if (!distance) return this;
+    if (distance < 0) return this.moveRight(-distance);
+
+    const last = Math.max(0, this.position.x - distance);
+    if (this.position.x === last) return this;
+
+    for (let j = this.position.x; j >= last; --j) {
+      let cell = this.cells[this.position.y][j];
+      if (!cell) cell = this.cells[this.position.y][j] = {};
+      switch (j) {
+        case this.position.x:
+          cell.l = this.theme;
+          break;
+        case last:
+          cell.r = this.theme;
+          break;
+        default:
+          cell.r = cell.l = this.theme;
+          break;
+      }
+    }
+
+    this.position.x = last;
+    return this;
+  }
+  moveRight(distance) {
+    if (!distance) return this;
+    if (distance < 0) return this.moveLeft(-distance);
+
+    const last = Math.min(this.width - 1, this.position.x + distance);
+    if (this.position.x === last) return this;
+
+    for (let j = this.position.x; j <= last; ++j) {
+      let cell = this.cells[this.position.y][j];
+      if (!cell) cell = this.cells[this.position.y][j] = {};
+      switch (j) {
+        case this.position.x:
+          cell.r = this.theme;
+          break;
+        case last:
+          cell.l = this.theme;
+          break;
+        default:
+          cell.r = cell.l = this.theme;
+          break;
+      }
+    }
+
+    this.position.x = last;
+    return this;
+  }
+  move(direction, distance) {
+    switch (direction) {
+      case Turtle.UP:
+        return this.moveUp(distance);
+      case Turtle.DOWN:
+        return this.moveDown(distance);
+      case Turtle.RIGHT:
+        return this.moveRight(distance);
+      case Turtle.LEFT:
+        return this.moveLeft(distance);
+    }
+    return this;
+  }
+  forward(distance) {
+    return this.move(this.direction, distance);
+  }
+  backward(distance) {
+    return this.move((this.direction + 2) % 4, distance);
+  }
+
+  markHalf(direction) {
+    let cell = this.cells[this.position.y][this.position.x];
+    if (!cell) cell = this.cells[this.position.y][this.position.x] = {};
+    switch (direction) {
+      case Turtle.UP:
+        cell.u = this.theme;
+        break;
+      case Turtle.DOWN:
+        cell.d = this.theme;
+        break;
+      case Turtle.RIGHT:
+        cell.r = this.theme;
+        break;
+      case Turtle.LEFT:
+        cell.l = this.theme;
+        break;
+    }
+    return this;
+  }
+  markHalfForward() {
+    return this.markHalf(this.direction);
+  }
+  markHalfBackward() {
+    return this.markHalf((this.direction + 2) % 4);
+  }
+  markHalfUp() {
+    return this.markHalf(Turtle.UP);
+  }
+  markHalfDown() {
+    return this.markHalf(Turtle.DOWN);
+  }
+  markHalfLeft() {
+    return this.markHalf(Turtle.LEFT);
+  }
+  markHalfRight() {
+    return this.markHalf(Turtle.RIGHT);
+  }
+}
+
+addAliases(Turtle, {
+  home: 'reset',
+  goto: 'set',
+  setPos: 'set',
+  setPosition: 'set',
+  advance: 'add',
+  lt: 'left',
+  rt: 'right',
+  fd: 'forward',
+  fwd: 'forward',
+  bk: 'backward',
+  back: 'backward',
+  bwd: 'backward',
+  setPen: 'setTheme',
+  setWidth: 'setTheme',
+  setDir: 'setDirection',
+  setNorth: 'setUp',
+  setSouth: 'setDown',
+  setWest: 'setLeft',
+  setEast: 'setRight',
+  moveNorth: 'moveUp',
+  moveSouth: 'moveDown',
+  moveWest: 'moveLeft',
+  moveEast: 'moveRight',
+  markHalfNorth: 'markHalfUp',
+  markHalfSouth: 'markHalfDown',
+  markHalfWest: 'markHalfLeft',
+  markHalfEast: 'markHalfRight'
+});
+
+export default Turtle;