console-toolkit 1.2.14 → 1.3.0

package/src/themes/lines/ascii-reddit.js

@@ -1,12 +1,8 @@
-import {populateTheme} from '../utils.js';
+import {makeLineTheme} from '../utils.js';
 
-/** ASCII Reddit-style line theme. */
-export const lineTheme = {};
-
-const markdownReddit11 = {t: ' | ', m: ' | ', b: ' | ', v: ' | ', h: '---'},
-  markdownReddit21 = {t: ' | ', m: ' | ', b: ' | ', v: ' | ', h: '==='};
-
-populateTheme(lineTheme, markdownReddit11, 1, 1);
-populateTheme(lineTheme, markdownReddit21, 2, 1);
+export const lineTheme = makeLineTheme([
+  [{t: ' | ', m: ' | ', b: ' | ', v: ' | ', h: '---'}, 1, 1],
+  [{t: ' | ', m: ' | ', b: ' | ', v: ' | ', h: '==='}, 2, 1]
+]);
 
 export default lineTheme;

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

@@ -1,12 +1,8 @@
-import {populateTheme} from '../utils.js';
+import {makeLineTheme} from '../utils.js';
 
-/** ASCII rounded line theme. */
-export const lineTheme = {};
-
-const rounded11 = {t: '...', m: ':+:', b: "'''", v: '|||', h: '---'},
-  rounded21 = {t: '...', m: ':+:', b: "'''", v: '|||', h: '==='};
-
-populateTheme(lineTheme, rounded11, 1, 1);
-populateTheme(lineTheme, rounded21, 2, 1);
+export const lineTheme = makeLineTheme([
+  [{t: '...', m: ':+:', b: "'''", v: '|||', h: '---'}, 1, 1],
+  [{t: '...', m: ':+:', b: "'''", v: '|||', h: '==='}, 2, 1]
+]);
 
 export default lineTheme;

package/src/themes/lines/ascii.js

@@ -1,12 +1,8 @@
-import {populateTheme} from '../utils.js';
+import {makeLineTheme} from '../utils.js';
 
-/** ASCII line theme. */
-export const lineTheme = {};
-
-const table11 = {t: '+++', m: '+++', b: '+++', v: '|||', h: '---'},
-  table21 = {t: '+++', m: '+++', b: '+++', v: '|||', h: '==='};
-
-populateTheme(lineTheme, table11, 1, 1);
-populateTheme(lineTheme, table21, 2, 1);
+export const lineTheme = makeLineTheme([
+  [{t: '+++', m: '+++', b: '+++', v: '|||', h: '---'}, 1, 1],
+  [{t: '+++', m: '+++', b: '+++', v: '|||', h: '==='}, 2, 1]
+]);
 
 export default lineTheme;

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

@@ -1,16 +1,10 @@
-import {populateTheme} from '../utils.js';
-
-/** Unicode bold box-drawing line theme. */
-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);
+import {makeLineTheme} from '../utils.js';
+
+export const lineTheme = makeLineTheme([
+  [{t: '┌┬┐', m: '├┼┤', b: '└┴┘', v: '│││', h: '───'}, 1, 1],
+  [{t: '┎┰┒', m: '┠╂┨', b: '┖┸┚', v: '┃┃┃', h: '───'}, 1, 2],
+  [{t: '┍┯┑', m: '┝┿┥', b: '┕┷┙', v: '│││', h: '━━━'}, 2, 1],
+  [{t: '┏┳┓', m: '┣╋┫', b: '┗┻┛', v: '┃┃┃', h: '━━━'}, 2, 2]
+]);
 
 export default lineTheme;

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

@@ -1,16 +1,10 @@
-import {populateTheme} from '../utils.js';
-
-/** Unicode rounded box-drawing line theme. */
-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);
+import {makeLineTheme} from '../utils.js';
+
+export const lineTheme = makeLineTheme([
+  [{t: '╭┬╮', m: '├┼┤', b: '╰┴╯', v: '│││', h: '───'}, 1, 1],
+  [{t: '╓╥╖', m: '╟╫╢', b: '╙╨╜', v: '║║║', h: '───'}, 1, 2],
+  [{t: '╒╤╕', m: '╞╪╡', b: '╘╧╛', v: '│││', h: '═══'}, 2, 1],
+  [{t: '╔╦╗', m: '╠╬╣', b: '╚╩╝', v: '║║║', h: '═══'}, 2, 2]
+]);
 
 export default lineTheme;

package/src/themes/lines/unicode.js

@@ -1,16 +1,10 @@
-import {populateTheme} from '../utils.js';
-
-/** Unicode box-drawing line theme. */
-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);
+import {makeLineTheme} from '../utils.js';
+
+export const lineTheme = makeLineTheme([
+  [{t: '┌┬┐', m: '├┼┤', b: '└┴┘', v: '│││', h: '───'}, 1, 1],
+  [{t: '╓╥╖', m: '╟╫╢', b: '╙╨╜', v: '║║║', h: '───'}, 1, 2],
+  [{t: '╒╤╕', m: '╞╪╡', b: '╘╧╛', v: '│││', h: '═══'}, 2, 1],
+  [{t: '╔╦╗', m: '╠╬╣', b: '╚╩╝', v: '║║║', h: '═══'}, 2, 2]
+]);
 
 export default lineTheme;

package/src/themes/utils.d.ts

@@ -31,3 +31,9 @@ export function populateTheme(
   hTheme: number | string,
   vTheme: number | string
 ): void;
+
+/** Builds a line theme from an array of `[tableDefinition, hTheme, vTheme]` entries.
+ * @param definitions - Array of populate-theme arguments.
+ * @returns A populated line theme.
+ */
+export function makeLineTheme(definitions: Array<[TableDefinition, number | string, number | string]>): LineTheme;

package/src/themes/utils.js

@@ -10,13 +10,12 @@
 
 // The default value for 'w': 1
 
-/** Populates a line theme object from a table definition matrix.
- * Sets `t_`, `h_`, `v_`, `w_`, and `f` properties on the lineTheme.
- * @param {object} lineTheme - The line theme object to populate.
- * @param {object} tableDefinition - Definition with `t`, `m`, `b`, `v`, `h`, optional `w` and `f` properties.
- * @param {string|number} hTheme - Horizontal theme identifier.
- * @param {string|number} vTheme - Vertical theme identifier.
- */
+export const makeLineTheme = definitions => {
+  const lineTheme = {};
+  for (const [table, hTheme, vTheme] of definitions) populateTheme(lineTheme, table, hTheme, vTheme);
+  return lineTheme;
+};
+
 export const populateTheme = (lineTheme, tableDefinition, hTheme, vTheme) => {
   const w = tableDefinition.w || 1,
     s = [0, w, w << 1],

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

@@ -15,39 +15,47 @@ const getIndex = cell => {
   return {skipFlag, hTheme, vTheme, hIndex, vIndex};
 };
 
-/** Draws a Turtle's path as line art using a line theme.
- * @param {import('./turtle.js').Turtle} turtle - The turtle to draw.
- * @param {object} lineTheme - The line theme defining border characters.
- * @param {object} [options] - Options.
- * @param {string} [options.ignore=' '] - Character for empty cells.
- * @returns {import('../box.js').Box} A Box with the rendered line art.
- */
-export const draw = (turtle, lineTheme, {ignore = ' '} = {}) =>
-  new Box(
+export const draw = (turtle, lineTheme, {ignore = ' '} = {}) => {
+  const wCache = {},
+    vCache = {},
+    hCache = {},
+    tCache = {};
+  return 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)
+            let w = wCache[vTheme];
+            if (w === undefined) w = wCache[vTheme] = lineTheme['w_' + vTheme];
+            if (w !== 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];
+            let v = vCache[vTheme];
+            if (v === undefined) v = vCache[vTheme] = lineTheme['v_' + vTheme];
+            if (!v) throw new TypeError(`Style has no "v_${vTheme}" property`);
+            return v[vIndex];
           }
           if (!vTheme) {
-            if (!lineTheme['h_' + hTheme]) throw new TypeError(`Style has no "h_${hTheme}" property`);
-            return lineTheme['h_' + hTheme][hIndex];
+            let h = hCache[hTheme];
+            if (h === undefined) h = hCache[hTheme] = lineTheme['h_' + hTheme];
+            if (!h) throw new TypeError(`Style has no "h_${hTheme}" property`);
+            return h[hIndex];
           }
-          if (lineTheme['w_' + vTheme] !== 1)
+          let w = wCache[vTheme];
+          if (w === undefined) w = wCache[vTheme] = lineTheme['w_' + vTheme];
+          if (w !== 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];
+          const tKey = hTheme + '_' + vTheme;
+          let t = tCache[tKey];
+          if (t === undefined) t = tCache[tKey] = lineTheme['t_' + hTheme + '_' + vTheme];
+          if (!t) throw new TypeError(`Style has no "t_${hTheme}_${vTheme}" property`);
+          return t[4 * hIndex + vIndex];
         })
         .join('')
     ),
     true
   );
+};
 
 export default draw;

package/src/turtle/draw-unicode.js

@@ -15,14 +15,6 @@ 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);
 
-/** Draws a Turtle's path using Unicode box-drawing characters.
- * Supports themes 1 (thin) and 2 (thick), and optional arc characters for corners.
- * @param {import('./turtle.js').Turtle} turtle - The turtle to draw.
- * @param {object} [options] - Options.
- * @param {string} [options.ignore=' '] - Character for empty cells.
- * @param {boolean} [options.useArcs] - If true, use rounded arc characters for corners.
- * @returns {import('../box.js').Box} A Box with the rendered Unicode drawing.
- */
 export const draw = (turtle, {ignore = ' ', useArcs} = {}) =>
   new Box(
     turtle.cells.map(row =>

package/src/turtle/index.d.ts

@@ -1,5 +1,5 @@
 import Turtle from './turtle.js';
-import {draw} from './draw-unicode.js';
+import draw from './draw-unicode.js';
 import Box from '../box.js';
 
 declare module './turtle.js' {

package/src/turtle/index.js

@@ -1,17 +1,9 @@
 import Turtle from './turtle.js';
 import draw from './draw-unicode.js';
 
-/** Draws the turtle's path as a Box using Unicode box-drawing characters.
- * @param {object} [options] - Draw options.
- * @returns {import('../box.js').default}
- */
 Turtle.prototype.toBox = function (options) {
   return draw(this, options);
 };
-/** Draws the turtle's path as a string array using Unicode box-drawing characters.
- * @param {object} [options] - Draw options.
- * @returns {string[]}
- */
 Turtle.prototype.toStrings = function (options) {
   return this.toBox(options).toStrings();
 };

package/src/turtle/turtle.js

@@ -1,8 +1,5 @@
 import {addAliases} from '../meta.js';
 
-/** Turtle graphics on a grid. Supports directional movement, line drawing, state save/restore, and various aliases.
- * @see {@link https://github.com/uhop/console-toolkit/wiki/Package:-turtle}
- */
 export class Turtle {
   static RIGHT = 0;
   static DOWN = 1;
@@ -14,11 +11,6 @@ export class Turtle {
   static WEST = 2;
   static NORTH = 3;
 
-  /** Creates a new Turtle on a grid of the given size.
-   * @param {number} width - Grid width.
-   * @param {number} height - Grid height.
-   * @param {number} [theme=1] - The line theme/pen width.
-   */
   constructor(width, height, theme = 1) {
     this.cells = new Array(height);
     for (let i = 0; i < height; ++i) {
@@ -33,136 +25,71 @@ export class Turtle {
     this.stack = [];
   }
 
-  /** Resets the turtle position to (0, 0).
-   * @returns {this}
-   */
   reset() {
     this.position.x = this.position.y = 0;
     return this;
   }
-  /** Sets the turtle position (clamped to grid bounds).
-   * @param {number} x
-   * @param {number} y
-   * @returns {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;
   }
-  /** Sets the X coordinate.
-   * @param {number} x
-   * @returns {this}
-   */
   setX(x) {
     this.position.x = Math.max(0, Math.min(this.width - 1, x));
     return this;
   }
-  /** Sets the Y coordinate.
-   * @param {number} y
-   * @returns {this}
-   */
   setY(y) {
     this.position.y = Math.max(0, Math.min(this.height - 1, y));
     return this;
   }
-  /** Moves the turtle by a relative offset without drawing.
-   * @param {number} dx - X offset.
-   * @param {number} dy - Y offset.
-   * @returns {this}
-   */
   add(dx, dy) {
     return this.set(this.position.x + dx, this.position.y + dy);
   }
-  /** Adds to the X coordinate.
-   * @param {number} dx - X offset.
-   * @returns {this}
-   */
   addX(dx) {
     return this.setX(this.position.x + dx);
   }
-  /** Adds to the Y coordinate.
-   * @param {number} dy - Y offset.
-   * @returns {this}
-   */
   addY(dy) {
     return this.setY(this.position.y + dy);
   }
 
-  /** Sets the line theme/pen width.
-   * @param {number} theme
-   * @returns {this}
-   */
   setTheme(theme) {
     this.theme = theme;
     return this;
   }
 
-  /** Sets the turtle direction (0=right, 1=down, 2=left, 3=up).
-   * @param {number} direction
-   * @returns {this}
-   */
   setDirection(direction) {
     this.direction = direction % 4;
     return this;
   }
-  /** Sets direction to up.
-   * @returns {this}
-   */
   setUp() {
     return this.setDirection(Turtle.UP);
   }
-  /** Sets direction to down.
-   * @returns {this}
-   */
   setDown() {
     return this.setDirection(Turtle.DOWN);
   }
-  /** Sets direction to left.
-   * @returns {this}
-   */
   setLeft() {
     return this.setDirection(Turtle.LEFT);
   }
-  /** Sets direction to right.
-   * @returns {this}
-   */
   setRight() {
     return this.setDirection(Turtle.RIGHT);
   }
-  /** Turns the turtle 90° to the left.
-   * @returns {this}
-   */
   left() {
     return this.setDirection((this.direction + 3) % 4);
   }
-  /** Turns the turtle 90° to the right.
-   * @returns {this}
-   */
   right() {
     return this.setDirection((this.direction + 1) % 4);
   }
 
-  /** Saves the current position, direction, and theme onto the stack.
-   * @returns {this}
-   */
   save() {
     this.stack.push([this.position.x, this.position.y, this.direction, this.theme]);
     return this;
   }
-  /** Restores the position, direction, and theme from the stack.
-   * @returns {this}
-   */
   restore() {
     if (!this.stack.length) throw new ReferenceError('Unmatched restore');
     [this.position.x, this.position.y, this.direction, this.theme] = this.stack.pop();
     return this;
   }
 
-  /** Moves the turtle up, drawing a line.
-   * @param {number} distance - Number of cells to move.
-   * @returns {this}
-   */
   moveUp(distance) {
     if (!distance) return this;
     if (distance < 0) return this.moveDown(-distance);
@@ -189,10 +116,6 @@ export class Turtle {
     this.position.y = last;
     return this;
   }
-  /** Moves the turtle down, drawing a line.
-   * @param {number} distance - Number of cells to move.
-   * @returns {this}
-   */
   moveDown(distance) {
     if (!distance) return this;
     if (distance < 0) return this.moveUp(-distance);
@@ -219,10 +142,6 @@ export class Turtle {
     this.position.y = last;
     return this;
   }
-  /** Moves the turtle left, drawing a line.
-   * @param {number} distance - Number of cells to move.
-   * @returns {this}
-   */
   moveLeft(distance) {
     if (!distance) return this;
     if (distance < 0) return this.moveRight(-distance);
@@ -249,10 +168,6 @@ export class Turtle {
     this.position.x = last;
     return this;
   }
-  /** Moves the turtle right, drawing a line.
-   * @param {number} distance - Number of cells to move.
-   * @returns {this}
-   */
   moveRight(distance) {
     if (!distance) return this;
     if (distance < 0) return this.moveLeft(-distance);
@@ -279,11 +194,6 @@ export class Turtle {
     this.position.x = last;
     return this;
   }
-  /** Moves the turtle in the given direction, drawing a line.
-   * @param {number} direction - Direction (0=right, 1=down, 2=left, 3=up).
-   * @param {number} distance - Number of cells to move.
-   * @returns {this}
-   */
   move(direction, distance) {
     switch (direction) {
       case Turtle.UP:
@@ -297,25 +207,13 @@ export class Turtle {
     }
     return this;
   }
-  /** Moves the turtle forward in its current direction.
-   * @param {number} distance - Number of cells to move.
-   * @returns {this}
-   */
   forward(distance) {
     return this.move(this.direction, distance);
   }
-  /** Moves the turtle backward (opposite of current direction).
-   * @param {number} distance - Number of cells to move.
-   * @returns {this}
-   */
   backward(distance) {
     return this.move((this.direction + 2) % 4, distance);
   }
 
-  /** Marks a half-line from the center of the current cell in the given direction.
-   * @param {number} direction - Direction (0=right, 1=down, 2=left, 3=up).
-   * @returns {this}
-   */
   markHalf(direction) {
     let cell = this.cells[this.position.y][this.position.x];
     if (!cell) cell = this.cells[this.position.y][this.position.x] = {};
@@ -335,39 +233,21 @@ export class Turtle {
     }
     return this;
   }
-  /** Marks a half-step line forward.
-   * @returns {this}
-   */
   markHalfForward() {
     return this.markHalf(this.direction);
   }
-  /** Marks a half-step line backward.
-   * @returns {this}
-   */
   markHalfBackward() {
     return this.markHalf((this.direction + 2) % 4);
   }
-  /** Marks a half-step line up.
-   * @returns {this}
-   */
   markHalfUp() {
     return this.markHalf(Turtle.UP);
   }
-  /** Marks a half-step line down.
-   * @returns {this}
-   */
   markHalfDown() {
     return this.markHalf(Turtle.DOWN);
   }
-  /** Marks a half-step line left.
-   * @returns {this}
-   */
   markHalfLeft() {
     return this.markHalf(Turtle.LEFT);
   }
-  /** Marks a half-step line right.
-   * @returns {this}
-   */
   markHalfRight() {
     return this.markHalf(Turtle.RIGHT);
   }