@slugbugblue/trax-cli 0.11.0

package/src/cmds/puzzles.js

@@ -0,0 +1,188 @@
+/** @file Puzzles CLI
+ * @copyright 2022-2023
+ * @author Chad Transtrum <chad@transtrum.net>
+ * @license Apache-2.0
+ */
+
+import { Trax } from '@slugbugblue/trax'
+import { levels, puzzles, sources } from '@slugbugblue/trax-puzzles'
+
+let maxLevel = 0
+const puzzleIds = []
+for (const puzzle of puzzles) {
+  maxLevel = Math.max(maxLevel, puzzle.level)
+  puzzleIds.push(puzzle.id)
+}
+
+const validLevels = levels.slice(0, maxLevel + 1)
+const completions = [...validLevels, ...puzzleIds].join('|')
+
+const listAliases = ['display', 'list', 'ls', 'show', 'view']
+const startAliases = ['new', 'start']
+
+export const puzzlesCmd = {
+  name: 'puzzles',
+  args: '["list"|"start"] [level|puzzle]',
+  comp: 'display|list|ls|new|show|start|view ' + completions,
+  desc: 'view and play puzzles',
+  help: [
+    'Practice your skills with puzzles. Use "list" to see the puzzle',
+    'categories, or "start" to play a puzzle.',
+  ],
+}
+
+const an = (word = '') => {
+  const a = /^[aeiou]/.test(word) ? 'an' : 'a'
+  return a + ' ' + word
+}
+
+const showPuzzle = (CLI, id, started = false) => {
+  let puzzle = puzzles.find((p) => p.id === id)
+  if (!puzzle) {
+    const possibles = puzzles.filter((p) => p.id.includes(id))
+    if (possibles.length === 1) puzzle = possibles[0]
+  }
+
+  if (!puzzle) return CLI.error(`Puzzle ${id} not found`)
+
+  const trax = new Trax(puzzle.game, puzzle.notation, 'cli')
+  const players = ['white', 'black']
+  CLI.display(trax, players)
+  let out = CLI.color.short(puzzle.id)
+  out += CLI.color(` is ${an(levels[puzzle.level])} puzzle`) + '\n'
+  if (puzzle.title) out += CLI.color(puzzle.title) + '\n'
+  if (puzzle.desc) out += CLI.color.help(puzzle.desc) + '\n'
+  out += CLI.color(players[puzzle.player - 1] + ' to win by move ' + puzzle.max)
+  const src = sources[puzzle.src]
+
+  if (src) {
+    let source = '\nPuzzle '
+    source += src.copyright
+      ? 'copyright ' + src.copyright + ' by'
+      : 'courtesy of'
+    source += ' ' + src.name
+    const url = src.url ? ' ' + CLI.color.help(src.url) : ''
+    out += CLI.color.white(source) + url
+    if (src.license) {
+      out += '\n' + CLI.color.optional('License: ' + src.license)
+      if (src.licenseUrl) out += CLI.color.black(' ' + src.licenseUrl)
+    }
+  }
+
+  CLI.out(out)
+
+  if (started) return
+
+  CLI.out(
+    CLI.color.short(
+      `Want to try this puzzle? Enter: "puzzles start ${puzzle.id}"`,
+    ),
+  )
+}
+
+const listPuzzles = (CLI) => {
+  let size = 1
+  const data = []
+  for (const name of validLevels) {
+    size = Math.max(size, name.length)
+    data.push({ name, count: 0, solved: 0, selected: false })
+  }
+
+  if (data[CLI.puzzleLevel]) data[CLI.puzzleLevel].selected = true
+
+  for (const puzzle of puzzles) {
+    data[puzzle.level].count += 1
+    if (CLI.puzzle(puzzle.id).solved > 0) data[puzzle.level].solved += 1
+  }
+
+  for (const category of data) {
+    let out = category.selected ? CLI.color('* ') : '  '
+    out += CLI.color.short(category.name.padEnd(size + 1))
+    if (category.solved === 0) {
+      out += CLI.color(CLI.plural(category.count, 'puzzle'))
+    } else if (category.solved === category.count) {
+      if (category.count > 3) out += CLI.color.success('all ')
+      out += CLI.color.success(CLI.plural(category.count, 'puzzle') + ' solved')
+    } else {
+      out += CLI.color.success(`${category.solved} solved`)
+      out += CLI.color(` of ${category.count} puzzles`)
+    }
+
+    CLI.out(out)
+  }
+}
+
+const listLevel = (CLI, levelName) => {
+  let size = 1
+  const level = levels.indexOf(levelName)
+  const data = []
+  for (const puzzle of puzzles) {
+    if (puzzle.level !== level) continue
+    size = Math.max(size, puzzle.id.length)
+    data.push({
+      id: puzzle.id,
+      title: puzzle.title,
+      solved: CLI.puzzle(puzzle.id).solved > 0,
+    })
+  }
+
+  for (const puzzle of data) {
+    let out = CLI.color.success(puzzle.solved ? '✓' : ' ')
+    out += CLI.color.short(' ' + puzzle.id)
+    if (puzzle.title) out += CLI.color(' ' + puzzle.title)
+    CLI.out(out)
+  }
+}
+
+const startPuzzle = (CLI, puzzle) => {
+  const id = CLI.newPuzzle(puzzle)
+  CLI.out(CLI.color(`Started puzzle ${puzzle.id} as game #${id}`))
+  showPuzzle(CLI, puzzle.id, true)
+}
+
+const startNextPuzzle = (CLI, level) => {
+  if (level === undefined) level = CLI.puzzleLevel
+  const unsolved = puzzles.filter((p) => !CLI.puzzle(p.id).solved)
+  if (unsolved.length === 0) {
+    CLI.out(CLI.success('You have already completed all the puzzles.'))
+    return CLI.error('Specify a specific puzzle to try one again.')
+  }
+
+  const next = unsolved.find((p) => p.level >= level) || unsolved[0]
+  startPuzzle(CLI, next)
+}
+
+puzzlesCmd.fn = (CLI, action, id) => {
+  action = action?.toLowerCase() ?? 'list'
+  if (startAliases.some((alias) => alias.startsWith(action))) {
+    if (!id) return startNextPuzzle(CLI)
+
+    const puzzle = puzzles.find((p) => p.id === id)
+    if (puzzle) {
+      return startPuzzle(CLI, puzzle)
+    }
+
+    if (validLevels.includes(id)) {
+      return startNextPuzzle(CLI, levels.indexOf(id))
+    }
+
+    const possibles = puzzles.filter((p) => p.id.includes(id))
+    if (possibles.length === 1) {
+      return startPuzzle(CLI, possibles[0])
+    }
+
+    return CLI.error('Could not find puzzle ' + id)
+  }
+
+  if (action) {
+    const x = id || action
+    if (validLevels.includes(x)) return listLevel(CLI, x)
+    if (listAliases.some((alias) => alias.startsWith(x))) {
+      return listPuzzles(CLI)
+    }
+
+    return showPuzzle(CLI, x)
+  }
+
+  listPuzzles(CLI)
+}

package/src/cmds/select.js

@@ -0,0 +1,47 @@
+/* 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 select command
+
+export const selectCmd = {
+  name: 'select',
+  alt: ['choose', '#'],
+  args: '#id [command]',
+  comp: '<id> <cmd>',
+  desc: 'select a different game',
+  rx: /^#\d+$/,
+  help: [
+    'Make another game the default game of future commands. If another',
+    'command is included, that command will be run immediately.',
+  ],
+}
+
+selectCmd.fn = (CLI, id, ...cmds) => {
+  if (!id) {
+    CLI.error('Missing id.')
+    return CLI.do('help', 'select')
+  }
+
+  if (id.startsWith('#')) id = id.slice(1)
+  CLI.load(id)
+  if (String(CLI.GAME?.id) === id) {
+    CLI.out(CLI.color(`Game #${id} selected.`))
+    if (cmds.length > 0) {
+      CLI.doNext(cmds.join(' '))
+    }
+  } else {
+    CLI.error('Invalid id. Type "list" to see available games.')
+  }
+}

package/src/cmds/suggest.js

@@ -0,0 +1,55 @@
+/* Copyright 2022-2023 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 suggest command
+
+import { suggest } from '@slugbugblue/trax-analyst'
+import { timeString } from '@slugbugblue/trax-cli/utils'
+
+export const suggestCmd = {
+  name: 'suggest',
+  alt: ['bot'],
+  desc: 'suggest a move',
+  help: ['Suggest a move in the current game.'],
+}
+
+suggestCmd.fn = (CLI, debug) => {
+  if (!String(CLI.GAME?.id)) {
+    return CLI.error('No active game. Type "new" to start a game.')
+  }
+
+  const game = CLI.TRAX
+  const suggestion = suggest(game)
+
+  if (!suggestion.best) return
+
+  CLI.out(
+    CLI.bubble(
+      game.turn === 1 ? 'w' : 'b',
+      String(game.move + 1) + '. ' + suggestion.pick.move,
+    ),
+  )
+
+  if ('debug'.startsWith(debug)) {
+    const m = []
+    for (const move of suggestion.options) {
+      m.push(move.move + ' ' + move.score)
+    }
+
+    CLI.out(
+      '[' + m.join(', ') + '] ' + CLI.color.black(timeString(suggestion.ms)),
+    )
+  }
+}

package/src/cmds/undo.js

@@ -0,0 +1,40 @@
+/* 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 undo command
+
+export const undoCmd = {
+  name: 'undo',
+  args: '[n]',
+  comp: '<move>',
+  desc: 'undo the last move in a game',
+  help: [
+    'Backtrack one or more moves in a game. Type "undo" to take back the last',
+    'move, or "undo 2" to undo the last two moves.',
+  ],
+}
+
+undoCmd.fn = (CLI, n) => {
+  n = Math.max(1, Math.floor(Number(n) || 1)) // Get an integer 1 or higher
+
+  const { moves } = CLI.TRAX
+  const undo = moves.slice(0, 0 - n)
+  if (moves.length === undo.length) {
+    CLI.error('Unable to undo.')
+  } else {
+    CLI.setGame(undo)
+    CLI.do('view')
+  }
+}

package/src/cmds/view.js

@@ -0,0 +1,65 @@
+/* Copyright 2022-2023 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 view command
+
+export const viewCmd = {
+  name: 'view',
+  alt: ['show', 'display'],
+  args: '[move number]',
+  comp: '<move>',
+  desc: 'show the game board',
+  help: [
+    'Show the current game. Include a move number to see the board as it was at',
+    'that move.',
+  ],
+}
+
+viewCmd.fn = (CLI, move, ...extra) => {
+  if (!CLI.GAME?.id) {
+    return CLI.error('No active game. Type "new" to start a game.')
+  }
+
+  if (move?.length > 1 && 'puzzles'.startsWith(move)) {
+    return CLI.do('puzzles', 'list', ...extra)
+  }
+
+  const trax = CLI.TRAX
+
+  let show = Number.POSITIVE_INFINITY
+  if (move && Number(move) >= 0 && Number(move) <= trax.moves.length) {
+    show = Number(move)
+  }
+
+  const game = CLI.GAME
+  const players = game.players || ['white', 'black']
+  const puzzle = game.puzzle || ''
+  const { note } = [...(game.notes || [{}])].pop()
+
+  CLI.out(
+    CLI.color('#' + CLI.ID + ' ') +
+      CLI.name(trax.rules) +
+      ' ' +
+      CLI.bubble('w' + (trax.turn === 1 ? 'h' : ''), players[0]) +
+      CLI.color(' vs ') +
+      CLI.bubble('b' + (trax.turn === 2 ? 'h' : ''), players[1]),
+  )
+  CLI.display(trax, players, undefined, show)
+  if (puzzle && (!note || !note.includes(puzzle))) {
+    CLI.out(CLI.color('Puzzle ' + puzzle))
+  }
+
+  if (note) CLI.out(CLI.color.help(note))
+}

package/src/types.d.ts

@@ -0,0 +1,105 @@
+/** Type information.
+ * @copyright 2022-2023
+ * @author Chad Transtrum <chad@transtrum.net>
+ * @license Apache-2.0
+ */
+
+/** Color is a single character to represent white or black. */
+type Color = 'w' | 'b'
+
+/** Colorize is a fancy function for colorizing text. */
+type Colorize = (text: string, def?: string | number) => string
+
+/** Colorer is a little too fancy. Hence the gnarly typescript. */
+type Colorer = {
+  (text: string, def?: string | number): string
+  black: Colorize
+  command: Colorize
+  default: Colorize
+  error: Colorize
+  fatal: Colorize
+  help: Colorize
+  id: Colorize
+  variable: Colorize
+  optional: Colorize
+  short: Colorize
+  white: Colorize
+}
+
+/** A note with a move number */
+type GameNote = {
+  move: number
+  note: string
+}
+
+/** Notes saved in the game object in the CLI. */
+type GameNotes = GameNote[]
+
+/** Treat the save state as an opaque object,
+ * produced by save() and fed into restore().
+ */
+type SaveState = {
+  id: string
+  move: number
+  turn: number
+  over: boolean
+  left: number
+  right: number
+  top: number
+  bottom: number
+  notation: string
+  tiles: string
+  path: string
+  invalid: boolean
+}
+
+/** Representations of the different ways a tile can curve.
+ * Matches the symbols used in Trax notation.
+ */
+type Slash = '/' | '\\' | '+'
+
+/** Threat definition. */
+type Threat = {
+  depth: number
+  pattern: string
+  rx: RegExp
+  value: number
+}
+
+/** A single tile on the board. */
+type Tile = {
+  id: TileId
+  loc: Point
+  type: TileType
+  move: number
+  seq: number
+}
+
+/** When a tile is dropped, this object represents the results. */
+type TileDrop = {
+  dropped: Tile[]
+  notation: string
+  valid: boolean
+}
+
+/** A TileId is just a string. */
+type TileId = string
+
+/** Invalid tiles are represented by 'x'. */
+type TileType = ValidTiles | 'x'
+
+/** All of the variants supported by the engine. */
+type TraxVariant = 'trax' | 'traxloop' | 'trax8'
+
+/** Tile type names are determined by listing the line color at each edge,
+ * starting from the top and going clockwise, and then sorted alphabetically
+ * and given a single letter name, so 'bbww' becomes 'a', which gives us six
+ * different tile names: a-f, as follows:
+ *     a         b        c        d        e        f
+ *  +--#--+   +--#--+  +--#--+  +--o--+  +--o--+  +--o--+
+ *  |   # |   |  #  |  | #   |  | o   |  |  o  |  |   o |
+ *  oo   ##   ooo#ooo  ##   oo  oo   ##  #######  ##   oo
+ *  | o   |   |  #  |  |   o |  |   # |  |  o  |  | #   |
+ *  +--o--+   +--#--+  +--o--+  +--#--+  +--o--+  +--#--+
+ */
+type ValidTiles = 'a' | 'b' | 'c' | 'd' | 'e' | 'f'

package/src/utils.js

@@ -0,0 +1,22 @@
+/** Shared utilities
+ * @copyright 2023
+ * @author Chad Transtrum <chad@transtrum.net>
+ * @license Apache-2.0
+ */
+
+/** Convert milliseconds to a human readable string in ms, sec, or min units.
+ * @arg {number} ms - the number of milliseconds
+ * @returns {string} a short human-readable representation of the time
+ */
+export const timeString = (ms) => {
+  if (ms < 1000) {
+    return (ms === Math.floor(ms) ? String(ms) : ms.toFixed(2)) + ' ms'
+  }
+
+  ms /= 1000
+  if (ms < 60) return ms.toFixed(3) + ' sec'
+
+  const min = Math.floor(ms / 60)
+  ms -= min * 60
+  return String(min) + ' min ' + ms.toFixed(3) + ' sec'
+}

package/src/version.js

@@ -0,0 +1,2 @@
+// Generated by genversion.
+export const version = '0.11.0'