@slugbugblue/trax 0.12.0 → 0.14.0

package/src/cmds/import-export.js

@@ -21,7 +21,8 @@ import process from 'node:process'
 import envPaths from 'env-paths'
 import makeDir from 'make-dir'
 
-import { Trax } from '../engine.js'
+import { Trax } from '@slugbugblue/trax'
+import { puzzles, sources } from '@slugbugblue/trax/puzzles'
 
 const paths = envPaths('trax', { suffix: '' })
 const PATHS = {}
@@ -30,7 +31,12 @@ const PATHS = {}
 let cli = {}
 
 const fsOuch = (fsError) => {
-  cli.out(fsError, cli.COLORS.fatal)
+  if (cli.out) {
+    cli.out(fsError, cli.COLORS.fatal)
+  } else {
+    console.log(fsError)
+  }
+
   throw fsError
 }
 
@@ -72,7 +78,12 @@ export const getFile = async (filetype, filename, variable, decode) => {
       }
     } catch (fsError) {
       if (fsError instanceof TypeError || fsError instanceof SyntaxError) {
-        cli.error(`Unable to read ${filetype} file ${path}/${filename}`)
+        const error = `Unable to read ${filetype} file ${path}/${filename}`
+        if (cli.error) {
+          cli.error(error)
+        } else {
+          console.log(error)
+        }
       } else if (fsError.code !== 'ENOENT') {
         fsOuch(fsError)
       }
@@ -200,6 +211,25 @@ exportCmd.fn = (CLI, id, filename) => {
   content += ' vs '
   content += game.players?.[1] || 'black'
   content += '\n; @slugbugblue/trax cli.js v' + CLI.version + '\n'
+  if (game.puzzle) {
+    const puzzle = puzzles.find((p) => p.id === game.puzzle)
+    if (puzzle) {
+      const source = sources[puzzle.src]
+      content += '; Puzzle ' + game.puzzle
+      if (source) {
+        content += ' provided courtesy of ' + source.name
+        if (source.url) content += ' (' + source.url + ')'
+      }
+
+      if (puzzle.title) content += '\n; ' + puzzle.title
+      if (puzzle.desc) content += '\n; ' + puzzle.desc
+      content += '\n; Starting position ' + puzzle.notation + '\n; '
+      const players = [0, 'white', 'black']
+      content += players[puzzle.player] + ' to win by move '
+      content += String(puzzle.max) + '\n'
+    }
+  }
+
   content += trax.notation + '\n'
   if (filename) filename = filename.replace(/[^ a-z\d.~/]/g, '')
   if (filename) {

package/src/cmds/list.js

@@ -15,7 +15,7 @@
 
 // CLI list command
 
-import { Trax } from '../engine.js'
+import { Trax } from '@slugbugblue/trax'
 
 export const listCmd = {
   name: 'list',
@@ -40,9 +40,6 @@ export const listCmd = {
   ],
 }
 
-const plural = (n, noun, nouns) =>
-  n + ' ' + (Math.abs(n) === 1 ? noun : nouns ? nouns : noun + 's')
-
 const alphaSort = (a, b) => {
   a = String(a).toLowerCase()
   b = String(b).toLowerCase()
@@ -120,7 +117,7 @@ listCmd.fn = (CLI, ...filters) => {
       id: (game.id === CLI.GAME.id ? '* #' : '#') + String(game.id),
       name: game.name?.length || 0,
       rules: game.rules,
-      moves: plural(moves, 'move'),
+      moves: CLI.plural(moves, 'move'),
       smoves: game.over ? '9999' : String(moves).padStart(9, '0'),
       sturn: String(game.turn),
       p1: game.players?.[0] || 'white',

package/src/cmds/new.js

@@ -42,7 +42,7 @@ const pairs = [
   ['Donald', 'Daisy'],
   ['Fred', 'Barney'],
   ['Fred', 'George'],
-  ['Frodo', 'Sam'],
+  ['Frodo', 'Samwise'],
   ['Han', 'Chewie'],
   ['Harry', 'Ron'],
   ['Holmes', 'Watson'],
@@ -58,13 +58,13 @@ const pairs = [
   ['Mario', 'Luigi'],
   ['Marlin', 'Dory'],
   ['Mary-Kate', 'Ashley'],
-  ['Micky', 'Minnie'],
+  ['Mickey', 'Minnie'],
   ['Miss Piggy', 'Kermit'],
   ['Mork', 'Mindy'],
   ['Obi-Wan', 'Anakin'],
   ['Pan', 'Hook'],
   ['Phineas', 'Ferb'],
-  ['Player 1', 'Player 2'],
+  ['player 1', 'player 2'],
   ['p1', 'p2'],
   ['R2-D2', 'C-3PO'],
   ['Ren', 'Stimpy'],
@@ -89,7 +89,9 @@ const pairs = [
 ]
 
 const pairUp = () => {
-  return pairs[Math.floor(Math.random() * pairs.length)]
+  const duo = pairs[Math.floor(Math.random() * pairs.length)]
+  if (duo[0].toLowerCase() !== duo[0] && Math.random() < 0.5) duo.reverse()
+  return duo
 }
 
 newCmd.fn = (CLI, variant, ...names) => {

package/src/cmds/play-try.js

@@ -15,6 +15,8 @@
 
 // CLI play/try commands
 
+import { suggest } from '@slugbugblue/trax/analyst'
+
 const moveRx = /^\d+\.?$/
 const notationRx = /^[@a-z]+\d+[bps/\\+]$/i
 
@@ -46,6 +48,40 @@ export const tryCmd = {
   ],
 }
 
+const bot = (CLI) => {
+  const game = CLI.GAME
+  const trax = CLI.TRAX
+  const players = game.players || ['a', 'b']
+  const name = players[trax.turn - 1]
+  if (trax.over && game.puzzle) {
+    if (trax.move <= game.max && name !== 'puzzlebot') {
+      CLI.puzzleSolved(game.puzzle)
+      return 'win'
+    }
+
+    return 'lose'
+  }
+
+  if (!trax.over && /bot\b/i.test(name)) {
+    if (game.puzzle && trax.move >= game.max) {
+      trax.play('puzzled')
+      return 'lose'
+    }
+
+    CLI.do('view')
+    CLI.out(CLI.bubble(trax.color + 'd', `${name} thinking...`))
+    const move = suggest(trax)?.pick?.move
+    if (move) {
+      CLI.out(CLI.bubble(trax.color + 'd', `${name} chooses ${move}`))
+      trax.play(move)
+    }
+
+    if (game.puzzle) return ' and win by move ' + String(game.max)
+  }
+
+  return ''
+}
+
 playCmd.fn = (CLI, ...moves) => {
   if (moves.length === 0 || !moves[0]) {
     CLI.error('You must provide a move.')
@@ -56,24 +92,27 @@ playCmd.fn = (CLI, ...moves) => {
     CLI.do('new')
   }
 
-  if (CLI.TRAX.over) {
+  const game = CLI.GAME
+  const trax = CLI.TRAX
+
+  if (trax.over) {
     return CLI.error('The game is over.')
   }
 
-  const start = CLI.TRAX.move
+  const start = trax.move
   let checkMove
 
   for (let move of moves) {
     if (notationRx.test(move)) {
-      const moveNumber = CLI.TRAX.move
+      const moveNumber = trax.move
       move = CLI.fixNotation(move)
       if (checkMove) {
-        CLI.TRAX.play(checkMove, move)
+        trax.play(checkMove, move)
       } else {
-        CLI.TRAX.play(move)
+        trax.play(move)
       }
 
-      if (CLI.TRAX.move === moveNumber) {
+      if (trax.move === moveNumber) {
         CLI.error(
           'Move "' +
             (checkMove ? checkMove + '. ' : '') +
@@ -88,9 +127,17 @@ playCmd.fn = (CLI, ...moves) => {
     }
   }
 
-  if (CLI.TRAX.move !== start) {
+  if (trax.move !== start) {
+    const result = bot(CLI)
     CLI.updateGameData()
     CLI.do('view')
+    if (result === 'lose') {
+      CLI.error('Failed to complete puzzle ' + game.puzzle)
+    } else if (result === 'win') {
+      CLI.out(CLI.color.success('You completed puzzle ' + game.puzzle))
+    } else if (result) {
+      CLI.out(result)
+    }
   }
 }
 

package/src/cmds/puzzles.js

@@ -0,0 +1,152 @@
+/** @file Puzzles CLI
+ * @copyright 2022
+ * @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('|')
+
+export const puzzlesCmd = {
+  name: 'puzzles',
+  args: '["list"|"start" [<difficulty>|<puzzleID>]]',
+  comp: 'list|ls|new|show|start|view ' + completions,
+  desc: 'play puzzles',
+  help: [
+    'Practice your skills with puzzles. Use "list" to see the puzzle',
+    'categories, or "start" to play a puzzle.',
+  ],
+}
+
+const showPuzzle = (CLI, id) => {
+  const puzzle = puzzles.find((p) => p.id === id)
+  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 a ' + 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.white(src.url) : ''
+    out += CLI.color.black(source) + url
+  }
+
+  CLI.out(out)
+}
+
+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)
+}
+
+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 ('start'.startsWith(action) || 'new'.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))
+    }
+
+    return CLI.error('Could not start puzzle ' + id)
+  }
+
+  if (action) {
+    if (validLevels.includes(id)) return listLevel(CLI, id)
+    if (puzzleIds.includes(id)) return showPuzzle(CLI, id)
+    if (id) return CLI.error('Could not find puzzle ' + id)
+  }
+
+  listPuzzles(CLI)
+}

package/src/cmds/suggest.js

@@ -0,0 +1,52 @@
+/* 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 suggest command
+
+import { suggest } from '@slugbugblue/trax/analyst'
+
+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(', ') + '] ' + suggestion.ms + 'ms')
+  }
+}

package/src/cmds/view.js

@@ -49,5 +49,5 @@ viewCmd.fn = (CLI, move) => {
       CLI.color(' vs ') +
       CLI.bubble('b' + (trax.turn === 2 ? 'h' : ''), players[1]),
   )
-  CLI.display(trax, players, false, show)
+  CLI.display(trax, players, undefined, show)
 }