@slugbugblue/trax-cli 0.12.0 → 0.13.0

package/src/cmds/suggest.js

@@ -1,19 +1,10 @@
-/* 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
+ * @copyright 2022-2026
+ * @author Chad Transtrum <chad@transtrum.net>
+ * @license Apache-2.0
  */
 
-// CLI suggest command
+/** @typedef {import('../cli.js').CLIContext} CLIContext */
 
 import { suggest } from '@slugbugblue/trax-analyst'
 import { timeString } from '@slugbugblue/trax-cli/utils'
@@ -23,33 +14,33 @@ export const suggestCmd = {
   alt: ['bot'],
   desc: 'suggest a move',
   help: ['Suggest a move in the current game.'],
-}
+  /** @param {CLIContext} CLI @param {string} [debug] */
+  fn(CLI, debug) {
+    if (!String(CLI.GAME?.id)) {
+      return CLI.error('No active game. Type "new" to start a 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)
 
-  const game = CLI.TRAX
-  const suggestion = suggest(game)
+    if (!suggestion.best) return
 
-  if (!suggestion.best) return
+    CLI.out(
+      CLI.bubble(
+        game.turn === 1 ? 'w' : 'b',
+        String(game.move + 1) + '. ' + suggestion.pick.move,
+      ),
+    )
 
-  CLI.out(
-    CLI.bubble(
-      game.turn === 1 ? 'w' : 'b',
-      String(game.move + 1) + '. ' + suggestion.pick.move,
-    ),
-  )
+    if (debug && 'debug'.startsWith(debug)) {
+      const m = []
+      for (const move of suggestion.options) {
+        m.push(move.move + ' ' + move.score)
+      }
 
-  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)),
+      )
     }
-
-    CLI.out(
-      '[' + m.join(', ') + '] ' + CLI.color.black(timeString(suggestion.ms)),
-    )
-  }
+  },
 }

package/src/cmds/undo.js

@@ -1,19 +1,12 @@
-/* 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
+ * @copyright 2022-2026
+ * @author Chad Transtrum <chad@transtrum.net>
+ * @license Apache-2.0
  */
 
-// CLI undo command
+/** @typedef {import('../cli.js').CLIContext} CLIContext */
+
+import { puzzles } from '@slugbugblue/trax-puzzles'
 
 export const undoCmd = {
   name: 'undo',
@@ -24,17 +17,29 @@ export const undoCmd = {
     '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
+  /** @param {CLIContext} CLI @param {string} [n] */
+  fn(CLI, n) {
+    const count = Math.max(1, Math.floor(Number(n) || 1))
+    const { moves } = CLI.TRAX
 
-  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')
-  }
+    if (CLI.GAME?.puzzle) {
+      const puzzle = puzzles.find((p) => p.id === CLI.GAME.puzzle)
+      const offset = puzzle ? puzzle.notation.split(' ').length : 0
+      const undoTo = Math.max(offset, moves.length - count * 2)
+      if (undoTo === moves.length) {
+        CLI.error('Cannot undo before the start of the puzzle.')
+      } else {
+        CLI.setGame(moves.slice(0, undoTo))
+        CLI.do('view')
+      }
+    } else {
+      const undo = moves.slice(0, 0 - count)
+      if (moves.length === undo.length) {
+        CLI.error('Unable to undo.')
+      } else {
+        CLI.setGame(undo)
+        CLI.do('view')
+      }
+    }
+  },
 }

package/src/cmds/view.js

@@ -1,19 +1,10 @@
-/* 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
+ * @copyright 2022-2026
+ * @author Chad Transtrum <chad@transtrum.net>
+ * @license Apache-2.0
  */
 
-// CLI view command
+/** @typedef {import('../cli.js').CLIContext} CLIContext */
 
 export const viewCmd = {
   name: 'view',
@@ -25,41 +16,41 @@ export const viewCmd = {
     '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))
+  /** @param {CLIContext} CLI @param {string} [move] @param {...string} extra */
+  fn(CLI, move, ...extra) {
+    if (!CLI.GAME?.id) {
+      return CLI.error('No active game. Type "new" to start a game.')
+    }
+
+    if (move && 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?.at(-1)?.note
+
+    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/utils.js

@@ -1,5 +1,5 @@
 /** Shared utilities
- * @copyright 2023
+ * @copyright 2023-2026
  * @author Chad Transtrum <chad@transtrum.net>
  * @license Apache-2.0
  */

package/src/version.js

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

package/xo.config.js

@@ -0,0 +1,10 @@
+/** @type {import('xo').FlatXoConfig} */
+const xoConfig = [
+  { ignores: ['exports/**'] },
+  {
+    prettier: true,
+    space: true,
+  },
+]
+
+export default xoConfig

package/src/types.d.ts

@@ -1,33 +0,0 @@
-/** Type information.
- * @copyright 2022-2023
- * @author Chad Transtrum <chad@transtrum.net>
- * @license Apache-2.0
- */
-
-/** Colorize is a fancy function for colorizing text. */
-type Colorize = (text: string, defaultColor?: string | number) => string
-
-/** Colorer is a little too fancy. Hence the gnarly typescript. */
-type Colorer = {
-  (text: string, defaultColor?: 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[]