@slugbugblue/trax-cli 0.12.1 → 0.14.0

package/src/cmds/list.js

@@ -1,19 +1,10 @@
-/* Copyright 2022 Chad Transtrum
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+/** CLI list command
+ * @copyright 2022-2026
+ * @author Chad Transtrum <chad@transtrum.net>
+ * @license Apache-2.0
  */
 
-// CLI list command
+/** @typedef {import('../cli.js').CLIContext} CLIContext */
 
 import process from 'node:process'
 import { Trax } from '@slugbugblue/trax'
@@ -39,8 +30,83 @@ export const listCmd = {
     "  <other text>: match a player's name or the latest game note",
     'Add the "reverse" option to reverse the sort order.',
   ],
+  /** @param {CLIContext} CLI @param {...string} filters */
+  fn(CLI, ...filters) {
+    if (Object.keys(CLI.GAMES).length === 0) {
+      return CLI.error('No games. Type "new" to start a new game.')
+    }
+
+    const puzzle = filters.find((f) => f.length > 1 && 'puzzles'.startsWith(f))
+    if (puzzle) return CLI.do('puzzles', ...filters.filter((f) => f !== puzzle))
+
+    /** @type {Array<Record<string, string | number | boolean | undefined>>} */
+    let list = []
+    const size = {
+      spacing: 13, // Amount of space taken up by fixed-length and between columns
+      id: 1,
+      name: 1,
+      moves: 1,
+      p1: 1,
+      p2: 1,
+    }
+
+    for (const game of Object.values(CLI.GAMES)) {
+      const moves = game.moves.length === 0 ? 0 : game.moves.split(' ').length
+      list.push({
+        sid: String(game.id).padStart(9, '0'),
+        id: (game.id === CLI.GAME.id ? '* #' : '#') + String(game.id),
+        name: game.name?.length || 0,
+        rules: game.rules,
+        moves: game.over ? 'game over' : CLI.plural(moves, 'move'),
+        smoves: game.over ? '9999' : String(moves).padStart(9, '0'),
+        sturn: String(game.turn),
+        p1: game.players?.[0] || 'white',
+        p2: game.players?.[1] || 'black',
+        turn: game.turn,
+        over: game.over,
+        note: game.notes?.at(-1)?.note || '',
+      })
+    }
+
+    list = listSort(list, filters)
+    renderList(CLI, list, size)
+  },
+}
+
+/**
+ * @param {CLIContext} CLI - the CLI object
+ * @param {Array<Record<string, string | number | boolean | undefined>>} list - sorted game list
+ * @param {Record<string, number>} size - initial column width minimums
+ */
+const renderList = (CLI, list, size) => {
+  let noteSize = Number.POSITIVE_INFINITY
+  for (const game of list) {
+    size.id = Math.max(size.id, String(game.id).length)
+    size.name = Math.max(size.name, Number(game.name))
+    size.moves = Math.max(size.moves, String(game.moves).length)
+    size.p1 = Math.max(size.p1, String(game.p1).length)
+    size.p2 = Math.max(size.p2, String(game.p2).length)
+    noteSize = Math.min(noteSize, leftover(size))
+  }
+
+  for (const game of list) {
+    CLI.out(
+      CLI.color(String(game.id).padStart(size.id) + ' ') +
+        Trax.names[
+          /** @type {import('../cli.js').TraxVariant} */ (String(game.rules))
+        ] +
+        ' '.repeat(size.name - Number(game.name) + 1) +
+        CLI.bubble(game.turn === 1 ? 'wh' : 'w', String(game.p1)) +
+        CLI.color('vs '.padStart(size.p1 - String(game.p1).length + 4)) +
+        CLI.bubble(game.turn === 2 ? 'bh' : 'b', String(game.p2)) +
+        CLI.color(' '.padStart(size.p2 - String(game.p2).length + 1)) +
+        CLI.color(String(game.moves).padEnd(size.moves)) +
+        CLI.color.help(' ' + String(game.note).slice(0, noteSize)),
+    )
+  }
 }
 
+/** @param {string} a @param {string} b @returns {number} */
 const alphaSort = (a, b) => {
   a = String(a).toLowerCase()
   b = String(b).toLowerCase()
@@ -49,6 +115,7 @@ const alphaSort = (a, b) => {
   return 0
 }
 
+/** @param {string | undefined} sort @returns {string} */
 const sortBy = (sort) => {
   if (!sort) return 'id'
   sort = sort.toLowerCase()
@@ -67,6 +134,11 @@ const sortBy = (sort) => {
   return sort
 }
 
+/**
+ * @param {Array<Record<string, string | number | boolean | undefined>>} list
+ * @param {string[]} filters
+ * @returns {Array<Record<string, string | number | boolean | undefined>>}
+ */
 const listSort = (list, filters) => {
   if (list.length === 0) return list
   let reverse = false
@@ -75,7 +147,7 @@ const listSort = (list, filters) => {
     if (by === 'reverse') {
       reverse = true
     } else if (list[0]?.[by]) {
-      list.sort((a, b) => alphaSort(a[by], b[by]))
+      list.sort((a, b) => alphaSort(String(a[by]), String(b[by])))
     } else if (by === 'trax') {
       list = list.filter((g) => g.rules === by)
     } else if (['over', 'active'].includes(by)) {
@@ -83,12 +155,16 @@ const listSort = (list, filters) => {
     } else {
       list = list.filter((g) => {
         return (
-          g.id.endsWith(by) ||
-          Trax.names[g.rules].toLowerCase().includes(by) ||
-          g.p1.toLowerCase().includes(by) ||
-          g.p2.toLowerCase().includes(by) ||
-          g.moves.startsWith(by + ' ') ||
-          g.note.includes(by)
+          String(g.id).endsWith(by) ||
+          Trax.names[
+            /** @type {import('../cli.js').TraxVariant} */ (String(g.rules))
+          ]
+            .toLowerCase()
+            .includes(by) ||
+          String(g.p1).toLowerCase().includes(by) ||
+          String(g.p2).toLowerCase().includes(by) ||
+          String(g.moves).startsWith(by + ' ') ||
+          String(g.note).includes(by)
         )
       })
     }
@@ -99,9 +175,9 @@ const listSort = (list, filters) => {
   return list
 }
 
-/** Find how many columns are left over after all the other columns arefilled.
- * @arg {Record<string, number>} sizes
- * @returns {number} number of columns left over
+/** Find how many columns are left over after all the other columns are filled.
+ * @param {Record<string, number>} sizes
+ * @returns {number}
  */
 const leftover = (sizes) => {
   let left = process.stdout.columns
@@ -111,66 +187,3 @@ const leftover = (sizes) => {
 
   return left
 }
-
-listCmd.fn = (CLI, ...filters) => {
-  if (Object.keys(CLI.GAMES).length === 0) {
-    return CLI.error('No games. Type "new" to start a new game.')
-  }
-
-  const puzzle = filters.find((f) => f.length > 1 && 'puzzles'.startsWith(f))
-  if (puzzle) return CLI.do('puzzles', ...filters.filter((f) => f !== puzzle))
-
-  let list = []
-  const size = {
-    spacing: 13, // Amount of space taken up by fixed-length and between columns
-    id: 1,
-    name: 1,
-    moves: 1,
-    p1: 1,
-    p2: 1,
-  }
-  let noteSize = Number.POSITIVE_INFINITY
-
-  for (const game of Object.values(CLI.GAMES)) {
-    const moves = game.moves.length === 0 ? 0 : game.moves.split(' ').length
-    list.push({
-      sid: String(game.id).padStart(9, '0'),
-      id: (game.id === CLI.GAME.id ? '* #' : '#') + String(game.id),
-      name: game.name?.length || 0,
-      rules: game.rules,
-      moves: game.over ? 'game over' : CLI.plural(moves, 'move'),
-      smoves: game.over ? '9999' : String(moves).padStart(9, '0'),
-      sturn: String(game.turn),
-      p1: game.players?.[0] || 'white',
-      p2: game.players?.[1] || 'black',
-      turn: game.turn,
-      over: game.over,
-      note: game.notes?.[game.notes.length - 1]?.note || '',
-    })
-  }
-
-  list = listSort(list, filters)
-
-  for (const game of list) {
-    size.id = Math.max(size.id, game.id.length)
-    size.name = Math.max(size.name, game.name)
-    size.moves = Math.max(size.moves, game.moves.length)
-    size.p1 = Math.max(size.p1, game.p1.length)
-    size.p2 = Math.max(size.p2, game.p2.length)
-    noteSize = Math.min(noteSize, leftover(size))
-  }
-
-  for (const game of list) {
-    CLI.out(
-      CLI.color(game.id.padStart(size.id) + ' ') +
-        Trax.names[game.rules] +
-        ' '.repeat(size.name - game.name + 1) +
-        CLI.bubble(game.turn === 1 ? 'wh' : 'w', game.p1) +
-        CLI.color('vs '.padStart(size.p1 - game.p1.length + 4)) +
-        CLI.bubble(game.turn === 2 ? 'bh' : 'b', game.p2) +
-        CLI.color(' '.padStart(size.p2 - game.p2.length + 1)) +
-        CLI.color(game.moves.padEnd(size.moves)) +
-        CLI.color.help(' ' + game.note.slice(0, noteSize)),
-    )
-  }
-}

package/src/cmds/new.js

@@ -1,19 +1,10 @@
-/* Copyright 2022 Chad Transtrum
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+/** CLI new command
+ * @copyright 2022-2026
+ * @author Chad Transtrum <chad@transtrum.net>
+ * @license Apache-2.0
  */
 
-// CLI new command
+/** @typedef {import('../cli.js').CLIContext} CLIContext */
 
 export const newCmd = {
   name: 'new',
@@ -25,6 +16,51 @@ export const newCmd = {
     'Valid variants are "trax", "loop", and "8x8". Defaults to "trax" if not',
     'specified. Use the "vs" keyword to use specific names for the players.',
   ],
+  /** @param {CLIContext} CLI @param {string} [variant] @param {...string} names */
+  fn(CLI, variant, ...names) {
+    let rules = ''
+    if (variant) {
+      variant = variant.toLowerCase()
+      if (variant.length > 1 && 'puzzles'.startsWith(variant)) {
+        return CLI.do('puzzles', 'new', ...names)
+      }
+
+      if (['8x8', '8', 'trax8x8', '8trax', '8x8trax'].includes(variant)) {
+        rules = 'trax8'
+      }
+
+      if (['loop', 'l', 'looptrax'].includes(variant)) rules = 'traxloop'
+      if (variant === 't') rules = 'trax'
+      if (['trax', 'traxloop', 'trax8'].includes(variant)) rules = variant
+
+      if (!rules) {
+        if (names.includes('vs') || names.includes('VS')) {
+          // We don't have a variant, we have player names
+          names.unshift(variant)
+        } else {
+          CLI.error('Unknown Trax variant.')
+          return CLI.do('help', 'new')
+        }
+      }
+    }
+
+    const players = pairUp()
+    if (names.length > 0) {
+      let vs = names.indexOf('vs')
+      if (vs === -1) vs = names.indexOf('VS')
+      if (vs >= 0) {
+        players[0] = names.slice(0, vs).join(' ') || 'white'
+        players[1] = names.slice(vs + 1).join(' ') || 'black'
+      }
+    }
+
+    const id = CLI.newGame(
+      /** @type {import('../cli.js').TraxVariant} */ (rules || 'trax'),
+      players,
+      '',
+    )
+    CLI.out(CLI.color('Started new game #' + id))
+  },
 }
 
 // Okay, yes, this is silly
@@ -32,6 +68,7 @@ const pairs = [
   ['Aang', 'Katara'],
   ['Abbott', 'Costello'],
   ['Adam', 'Eve'],
+  ['Ali', 'Frazier'],
   ['Anne Boleyn', 'Henry VIII'],
   ['Ash', 'Pikachu'],
   ['Barbie', 'Ken'],
@@ -44,12 +81,15 @@ const pairs = [
   ['Chip', 'Dale'],
   ['Donald', 'Daisy'],
   ['Depp', 'Heard'],
+  ['Dorothy', 'Toto'],
   ['Fred', 'Barney'],
   ['Fred', 'George'],
+  ['Frida', 'Diego'],
   ['Frodo', 'Samwise'],
   ['Hamilton', 'Burr'],
   ['Han', 'Chewie'],
   ['Harry', 'Ron'],
+  ['Hatfield', 'McCoy'],
   ['Holmes', 'Moriarty'],
   ['Holmes', 'Watson'],
   ['Iñigo', 'Fezzik'],
@@ -73,6 +113,7 @@ const pairs = [
   ['Pan', 'Hook'],
   ['Phineas', 'Ferb'],
   ['player 1', 'player 2'],
+  ['p1', 'p2'],
   ['Potter', 'Voldemort'],
   ['R2-D2', 'C-3PO'],
   ['Ren', 'Stimpy'],
@@ -85,6 +126,7 @@ const pairs = [
   ['Snoopy', 'Woodstock'],
   ['Sonny', 'Cher'],
   ['Spongebob', 'Patrick'],
+  ['Sully', 'Neytiri'],
   ['Tarzan', 'Jane'],
   ['Thelma', 'Louise'],
   ['Thing 1', 'Thing 2'],
@@ -103,44 +145,3 @@ const pairUp = () => {
   if (duo[0].toLowerCase() !== duo[0] && Math.random() < 0.5) duo.reverse()
   return duo
 }
-
-newCmd.fn = (CLI, variant, ...names) => {
-  let rules = ''
-  if (variant) {
-    variant = variant.toLowerCase()
-    if (variant.length > 1 && 'puzzles'.startsWith(variant)) {
-      return CLI.do('puzzles', 'new', ...names)
-    }
-
-    if (['8x8', '8', 'trax8x8', '8trax', '8x8trax'].includes(variant)) {
-      rules = 'trax8'
-    }
-
-    if (['loop', 'l', 'looptrax'].includes(variant)) rules = 'traxloop'
-    if (variant === 't') rules = 'trax'
-    if (['trax', 'traxloop', 'trax8'].includes(variant)) rules = variant
-
-    if (!rules) {
-      if (names.includes('vs') || names.includes('VS')) {
-        // We don't have a variant, we have player names
-        names.unshift(variant)
-      } else {
-        CLI.error('Unknown Trax variant.')
-        return CLI.do('help', 'new')
-      }
-    }
-  }
-
-  const players = pairUp()
-  if (names.length > 0) {
-    let vs = names.indexOf('vs')
-    if (vs === -1) vs = names.indexOf('VS')
-    if (vs >= 0) {
-      players[0] = names.slice(0, vs).join(' ') || 'white'
-      players[1] = names.slice(vs + 1).join(' ') || 'black'
-    }
-  }
-
-  const id = CLI.newGame(rules, players, '')
-  CLI.out(CLI.color('Started new game #' + id))
-}

package/src/cmds/notes.js

@@ -1,9 +1,11 @@
 /** Notes CLI command.
- * @copyright 2022
+ * @copyright 2022-2026
  * @author Chad Transtrum <chad@transtrum.net>
  * @license Apache-2.0
  */
 
+/** @typedef {import('../cli.js').CLIContext} CLIContext */
+
 export const notesCmd = {
   name: 'notes',
   args: '[#id] <text>',
@@ -12,26 +14,26 @@ export const notesCmd = {
     'Add a short note to a game that will be shown when the game is',
     'displayed, listed, or exported.',
   ],
-}
-
-notesCmd.fn = (CLI, id, ...note) => {
-  const current = String(CLI.GAME.id)
-  id ||= current
-  if (!/^#?\d+$/.test(id)) {
-    note.unshift(id)
-    id = current
-  }
+  /** @param {CLIContext} CLI @param {string} [id] @param {...string} note */
+  fn(CLI, id, ...note) {
+    const current = String(CLI.GAME.id)
+    id ||= current
+    if (!/^#?\d+$/v.test(id)) {
+      note.unshift(id)
+      id = current
+    }
 
-  if (id.startsWith('#')) id = id.slice(1)
+    if (id.startsWith('#')) id = id.slice(1)
 
-  const game = CLI.GAMES[id]
+    const game = CLI.GAMES[id]
 
-  if (!game) return CLI.error('Game not found.')
+    if (!game) return CLI.error('Game not found.')
 
-  const notes = game.notes || []
-  const move = game.moves.length > 0 ? game.moves.split(' ').length : 0
+    const notes = game.notes || []
+    const move = game.moves.length > 0 ? game.moves.split(' ').length : 0
 
-  notes.push({ move, note: note.join(' ') })
-  game.notes = notes
-  CLI.save()
+    notes.push({ move, note: note.join(' ') })
+    game.notes = notes
+    CLI.save()
+  },
 }