@slugbugblue/trax-cli 0.11.0 → 0.12.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @slugbugblue/trax
 
+## 0.12.1 - 2025-12-02
+
+- Bugfix: file read/write broken after migrating to mkdir with different
+  signature
+
+## 0.12.0 - 2025-11-08
+
+- Fix a rare bug that could alter player names of existing games
+- The `version` command now also shows version of some dependencies
+- Update dependencies
+- Update code to meet new xo guidelines
+
 ## 0.11.0 - 2023-03-25
 
 - Pull CLI from `@slugbugblue/trax` into its own repository
@@ -15,11 +27,9 @@
 ## 0.9.0 - 2023-02-05
 
 - CLI improvements:
-
   - Puzzle information is now stored as notes, to make it searchable
 
 - More puzzles:
-
   - Martin M. S. Pedersen contributed eleven new puzzles
 
 ## 0.8.0 - 2022-12-29
@@ -29,7 +39,6 @@
 ## 0.7.0 - 2022-12-27
 
 - Added a `notes` command to the CLI to add comments to a game
-
   - all comments are included in the output generated by the `export` command
   - the latest comment can be used as a text filter by the `list` command
   - the latest comment is displayed by the `view` and `list` commands
@@ -37,32 +46,27 @@
 ## 0.6.0 - 2022-12-14
 
 - Added shared `puzzles` commands to the CLI:
-
   - `trax ls puzzles`: see all the puzzles
   - `trax new puzzle`: start a new puzzle
 
 ## 0.5.0 - 2022-12-05
 
 - Added `puzzles` to the CLI:
-
   - `trax puzzles ls`: see all the puzzles
   - `trax puzzle new`: start a new puzzle
 
 ## 0.4.0 - 2022-11-25
 
 - Utilize the newly added move suggestions from `trax-analyst` to the CLI
-
   - added the `suggest` CLI command for quick access to a random suggestion
 
 - Use font glyphs for text bubbles in `tty.js` only if one of the following
   environment variables are defined and non-empty:
-
   - `NERDFONT`, `POWERLINE`, `P9K_TTY`, `P9K_SSH`
 
 ## 0.3.0 - 2022-09-22
 
 - Added the initial work on `trax-analyst`
-
   - added the `analyze` CLI command to see an analysis
 
 ## 0.2.0 - 2022-04-24

package/README.md

@@ -150,7 +150,7 @@ Trax][gnutrax] for over two decades, and has a lot of expertise in this area.
 
 ## License
 
-Copyright 2019-2023 Chad Transtrum
+Copyright 2019-2025 Chad Transtrum
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use
 the files in this project except in compliance with the License. You may obtain

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slugbugblue/trax-cli",
-  "version": "0.11.0",
+  "version": "0.12.1",
   "description": "Trax command line interface",
   "keywords": [
     "trax",
@@ -15,9 +15,7 @@
   "types": "./src/types.d.ts",
   "exports": {
     ".": "./src/cli.js",
-    "./utils": "./src/utils.js",
-    "./version": "./src/version.js",
-    "./version.js": "./src/version.js"
+    "./utils": "./src/utils.js"
   },
   "repository": "gitlab:slugbugblue/trax-cli",
   "bin": {
@@ -25,27 +23,26 @@
   },
   "scripts": {
     "genversion": "genversion --es6 src/version.js",
-    "git-add": "git add src/version.js benchmark/benchmarks.json",
+    "git-add": "git add src/version.js",
     "test": "xo",
-    "prepare": "husky install",
+    "prepare": "husky",
     "preversion": "npm test",
     "version": "npm run genversion ; npm run git-add",
     "postversion": "git push && git push --tags && npm publish"
   },
   "dependencies": {
-    "@slugbugblue/trax": "^0.21.0",
-    "@slugbugblue/trax-analyst": "^0.11.0",
+    "@slugbugblue/trax": "^1.0.0",
+    "@slugbugblue/trax-analyst": "^0.13.0",
     "@slugbugblue/trax-puzzles": "^0.5.0",
     "@slugbugblue/trax-tty": "^1.0.0",
     "env-paths": "^3.0.0",
-    "make-dir": "^3.1.0",
     "yaml": "^2.0.0-11"
   },
   "devDependencies": {
     "genversion": "^3.0.2",
-    "husky": "^8.0.3",
-    "prettier": "^2.6.1",
-    "xo": "0.*"
+    "husky": "^9.0.1",
+    "prettier": "^3.2.0",
+    "xo": "^1.2.3"
   },
   "type": "module",
   "engines": {
@@ -61,6 +58,7 @@
   },
   "xo": {
     "prettier": true,
+    "space": true,
     "rules": {
       "curly": [
         "error",

package/src/cli.js

@@ -18,13 +18,11 @@
 
 import process from 'node:process'
 import repl from 'node:repl'
-
 import YAML from 'yaml'
-
 import { Trax } from '@slugbugblue/trax'
-import { version } from '@slugbugblue/trax-cli/version'
+import { version as traxVersion } from '@slugbugblue/trax/version'
+import { version as analystVersion } from '@slugbugblue/trax-analyst'
 import * as tty from '@slugbugblue/trax-tty'
-
 // Load all the commands as individual plugins
 import { analyzeCmd } from './cmds/analyze.js'
 import { deleteCmd } from './cmds/delete.js'
@@ -45,6 +43,7 @@ import { selectCmd } from './cmds/select.js'
 import { suggestCmd } from './cmds/suggest.js'
 import { undoCmd } from './cmds/undo.js'
 import { viewCmd } from './cmds/view.js'
+import { version } from './version.js'
 
 // Because typeof [] and null are both 'object'. is([], 'arr') => true
 const is = (variable, type) =>
@@ -60,7 +59,15 @@ const versionCmd = {
   opts: ['--version', '-v'],
   desc: 'display version number',
   help: 'Print out the current version of this program.',
-  fn: (CLI) => CLI.out('Trax CLI v' + version),
+  fn: (CLI) =>
+    CLI.out(
+      [
+        `Trax: engine v${traxVersion}`,
+        `analyst v${analystVersion}`,
+        `tty v${tty.version}`,
+        `cli v${version}`,
+      ].join(' | '),
+    ),
 }
 
 const quitCmd = {
@@ -121,12 +128,12 @@ const newId = (DATA) => {
  * @type Colorer
  */
 // @ts-ignore
-const color = (text, def) => {
+const color = (text, defaultColor) => {
   let out = ''
   let quote = false
   let id = false
-  const colors = [def]
-  const c = (t) => tty.color(t, colors[colors.length - 1] || CLI.COLORS.default)
+  const colors = [defaultColor]
+  const c = (t) => tty.color(t, colors.at(-1) || CLI.COLORS.default)
   const short = (t) => tty.color(t, CLI.COLORS.short) + c()
   for (const char of text) {
     switch (char) {
@@ -190,7 +197,7 @@ const color = (text, def) => {
     }
   }
 
-  return tty.color(out, def || CLI.COLORS.default)
+  return tty.color(out, defaultColor || CLI.COLORS.default)
 }
 
 // Internal representations of files
@@ -286,7 +293,7 @@ const CLI = {
   },
 
   load(id) {
-    if (!id) id = Object.keys(DATA.games || {})[0]
+    id ||= Object.keys(DATA.games || {})[0]
     if (id && DATA.games?.[id] && DATA.games[id].rules) {
       if (id !== String(CONFIG.id)) {
         CONFIG.id = id
@@ -294,7 +301,7 @@ const CLI = {
       }
 
       const game = CLI.GAME
-      if (!game.players) game.players = ['white', 'black']
+      game.players ||= ['white', 'black']
       CLI.TRAX = new Trax(game.rules, game.moves, 'cli')
     }
   },
@@ -376,8 +383,8 @@ const CLI = {
   },
 
   puzzleSolved(id) {
-    DATA.puzzles = DATA.puzzles || {}
-    DATA.puzzles[id] = DATA.puzzles[id] || { attempts: 1, solved: 0 }
+    DATA.puzzles ||= {}
+    DATA.puzzles[id] ||= { attempts: 1, solved: 0 }
     DATA.puzzles[id].solved += 1
   },
 
@@ -586,7 +593,7 @@ const expand = (completions, match) => {
 const completer = (line) => {
   const words = line.split(/\s+/).filter(Boolean)
 
-  let match = words.slice(-1)[0] || ''
+  let match = words.at(-1) || ''
   const previous = new Set(words.slice(1, -1).map((s) => s.toLowerCase()))
   if (line.endsWith(' ')) {
     previous.add(match.toLowerCase())
@@ -614,11 +621,9 @@ const completer = (line) => {
     const word = completions[i]
     if (word.includes('|')) {
       const comps = word.split('|')
-      if (comps.some((c) => previous.has(c.toLowerCase()))) {
-        completions[i] = ''
-      } else {
-        completions[i] = comps
-      }
+      completions[i] = comps.some((c) => previous.has(c.toLowerCase()))
+        ? ''
+        : comps
     }
   }
 

package/src/cmds/delete.js

@@ -44,7 +44,7 @@ const selectAnyGame = (CLI) => {
 
 deleteCmd.fn = (CLI, id, force = 'x') => {
   const current = String(CLI.GAME.id)
-  if (!id) id = current
+  id ||= current
   if ('force'.startsWith(id)) {
     id = current
     force = 'force'

package/src/cmds/help.js

@@ -29,7 +29,7 @@ export const helpCmd = {
 }
 
 // Find the length of the printable characters of the string
-const length = (text) => text.replace(/[<">]/g, '').length
+const length = (text) => text.replaceAll(/[<">]/g, '').length
 
 helpCmd.fn = (CLI, word) => {
   // If we are looking for help on a particular commands, get that command

package/src/cmds/import-export.js

@@ -1,4 +1,4 @@
-/* Copyright 2022-2023 Chad Transtrum
+/* Copyright 2022-2025 Chad Transtrum
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,10 +17,7 @@
 
 import fs from 'node:fs/promises'
 import process from 'node:process'
-
 import envPaths from 'env-paths'
-import makeDir from 'make-dir'
-
 import { Trax } from '@slugbugblue/trax'
 import { puzzles, sources } from '@slugbugblue/trax-puzzles'
 
@@ -51,7 +48,8 @@ const expandPath = (name) => {
 const getPath = async (path) => {
   if (path in PATHS) return PATHS[path]
   if (path in paths) {
-    const realPath = await makeDir(paths[path])
+    const realPath = paths[path]
+    await fs.mkdir(realPath, { recursive: true })
     PATHS[path] = realPath
     return realPath
   }
@@ -93,24 +91,21 @@ export const getFile = async (filetype, filename, variable, decode) => {
   return variable
 }
 
-export const saveFile = (filetype, filename, data) => {
-  getPath(filetype).then((path) => {
-    if (path) {
-      const parts = filename.split('.')
-      parts.splice(1, 0, hexy())
-      const tmpfile = path + '/' + parts.join('.')
-      filename = path + '/' + filename
-      fs.writeFile(tmpfile, data)
-        .then(() => {
-          fs.rm(filename, { force: true, maxRetries: 5 })
-            .then(() => {
-              fs.rename(tmpfile, filename).catch(fsOuch)
-            })
-            .catch(fsOuch)
-        })
-        .catch(fsOuch)
+export const saveFile = async (filetype, filename, data) => {
+  const path = await getPath(filetype)
+  if (path) {
+    const parts = filename.split('.')
+    parts.splice(1, 0, hexy())
+    const tmpfile = path + '/' + parts.join('.')
+    filename = path + '/' + filename
+    try {
+      await fs.writeFile(tmpfile, data)
+      await fs.rm(filename, { force: true, maxRetries: 5 })
+      await fs.rename(tmpfile, filename)
+    } catch (error) {
+      fsOuch(error)
     }
-  })
+  }
 }
 
 export const importCmd = {
@@ -182,7 +177,7 @@ const interpretFile = (CLI, content) => {
         })
       } else {
         trax.playMoves(moves.filter(Boolean))
-        moves.splice(0, moves.length)
+        moves.splice(0)
       }
     }
 
@@ -243,12 +238,12 @@ importCmd.fn = async (CLI, filename) => {
  * @returns {string} - Notes formatted for this move, or empty string if none
  */
 const gameNotes = (move, notes) => {
-  notes = notes || []
+  notes ||= []
   const moveNotes = notes.filter((n) => n.move === move)
   if (moveNotes.length === 0) return ''
   return (
     '; ' +
-    moveNotes.map((n) => n.note.replace(/\n/g, '\n; ')).join('\n; ') +
+    moveNotes.map((n) => n.note.replaceAll('\n', '\n; ')).join('\n; ') +
     '\n'
   )
 }
@@ -299,7 +294,7 @@ const interleaveNotation = (moves, notes) => {
   return content
 }
 
-exportCmd.fn = (CLI, id, filename) => {
+exportCmd.fn = async (CLI, id, filename) => {
   cli = CLI
   let game = CLI.GAME
   if (id) {
@@ -345,13 +340,17 @@ exportCmd.fn = (CLI, id, filename) => {
 
   content += interleaveNotation(trax.moves, game.notes)
 
-  if (filename) filename = filename.replace(/[^ a-z\d.~/]/g, '')
+  filename &&= filename.replaceAll(/[^ a-z\d.~/]/g, '')
   if (filename) {
     const fname = filename.split('/').pop()
     if (!fname) filename += game.rules + game.id
     if (!fname.includes('.')) filename += '.trx'
     CLI.out(CLI.color('Exporting #' + game.id + ' to ') + filename)
-    fs.writeFile(expandPath(filename), content).catch(fsOuch)
+    try {
+      fs.writeFile(expandPath(filename), content)
+    } catch (error) {
+      fsOuch(error)
+    }
   } else {
     CLI.out(content)
   }
@@ -373,9 +372,11 @@ export const findFiles = (path) => {
   if (!FOLDERS[prefix]) {
     FOLDERS[prefix] = []
     fs.readdir(folder, { withFileTypes: true })
+      // eslint-disable-next-line promise/prefer-await-to-then
       .then((dir) => {
-        // This is all happening asynchronously, so we have to call findFiles
-        // at least twice before we get any useful information ...
+        // At this point, everything is happening asynchronously,
+        // so we have to call findFiles at least twice before we
+        // get any useful information ...
         const entries = []
         for (const entry of dir) {
           if (entry.isDirectory() && !entry.name.startsWith('.')) {
@@ -387,7 +388,10 @@ export const findFiles = (path) => {
 
         FOLDERS[prefix] = entries
       })
-      .catch(() => {})
+      // eslint-disable-next-line promise/prefer-await-to-then
+      .catch(() => {
+        // Errors are unimportant and should be silently ignored
+      })
   }
 
   return FOLDERS[prefix]

package/src/cmds/list.js

@@ -16,7 +16,6 @@
 // CLI list command
 
 import process from 'node:process'
-
 import { Trax } from '@slugbugblue/trax'
 
 export const listCmd = {

package/src/cmds/new.js

@@ -29,6 +29,7 @@ export const newCmd = {
 
 // Okay, yes, this is silly
 const pairs = [
+  ['Aang', 'Katara'],
   ['Abbott', 'Costello'],
   ['Adam', 'Eve'],
   ['Anne Boleyn', 'Henry VIII'],
@@ -38,14 +39,20 @@ const pairs = [
   ['Bert', 'Ernie'],
   ['Bonnie', 'Clyde'],
   ['Calvin', 'Hobbes'],
+  ['Chandler', 'Monica'],
+  ['Chewbacca', 'R2-D2'],
   ['Chip', 'Dale'],
   ['Donald', 'Daisy'],
+  ['Depp', 'Heard'],
   ['Fred', 'Barney'],
   ['Fred', 'George'],
   ['Frodo', 'Samwise'],
+  ['Hamilton', 'Burr'],
   ['Han', 'Chewie'],
   ['Harry', 'Ron'],
+  ['Holmes', 'Moriarty'],
   ['Holmes', 'Watson'],
+  ['Iñigo', 'Fezzik'],
   ['Jekyll', 'Hyde'],
   ['Jim', 'Pam'],
   ['Joe', 'Volcano'],
@@ -62,14 +69,16 @@ const pairs = [
   ['Miss Piggy', 'Kermit'],
   ['Mork', 'Mindy'],
   ['Obi-Wan', 'Anakin'],
+  ['p1', 'p2'],
   ['Pan', 'Hook'],
   ['Phineas', 'Ferb'],
   ['player 1', 'player 2'],
-  ['p1', 'p2'],
+  ['Potter', 'Voldemort'],
   ['R2-D2', 'C-3PO'],
   ['Ren', 'Stimpy'],
   ['Rick', 'Morty'],
   ['Romeo', 'Juliet'],
+  ['Ross', 'Rachel'],
   ['Shaggy', 'Scooby'],
   ['Shrek', 'Fiona'],
   ['Simon', 'Garfunkel'],
@@ -84,12 +93,13 @@ const pairs = [
   ['Tweety', 'Sylvester'],
   ['Waldorf', 'Statler'],
   ['Wallace', 'Gromit'],
+  ['Westley', 'Buttercup'],
   ['white', 'black'],
   ['Woody', 'Buzz'],
 ]
 
 const pairUp = () => {
-  const duo = 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
 }

package/src/cmds/notes.js

@@ -16,7 +16,7 @@ export const notesCmd = {
 
 notesCmd.fn = (CLI, id, ...note) => {
   const current = String(CLI.GAME.id)
-  if (!id) id = current
+  id ||= current
   if (!/^#?\d+$/.test(id)) {
     note.unshift(id)
     id = current

package/src/cmds/play-try.js

@@ -31,7 +31,7 @@ export const playCmd = {
   help: [
     'Enter the move in standard Trax notation. The final character of the',
     'notation can be replaced with a letter for ease of entering at the',
-    'command line. Use <s> for "/", <b> for "\\", and <p> for "+".',
+    String.raw`command line. Use <s> for "/", <b> for "\", and <p> for "+".`,
     'Multiple moves can be submitted at once. Move numbers are optional,',
     'but if included, they will be checked for accuracy.',
   ],

package/src/cmds/puzzles.js

@@ -53,19 +53,19 @@ const showPuzzle = (CLI, id, started = false) => {
   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]
+  const source = sources[puzzle.src]
 
-  if (src) {
-    let source = '\nPuzzle '
-    source += src.copyright
-      ? 'copyright ' + src.copyright + ' by'
+  if (source) {
+    let text = '\nPuzzle '
+    text += source.copyright
+      ? 'copyright ' + source.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)
+    text += ' ' + source.name
+    const url = source.url ? ' ' + CLI.color.help(source.url) : ''
+    out += CLI.color.white(text) + url
+    if (source.license) {
+      out += '\n' + CLI.color.optional('License: ' + source.license)
+      if (source.licenseUrl) out += CLI.color.black(' ' + source.licenseUrl)
     }
   }
 

package/src/types.d.ts

@@ -4,15 +4,12 @@
  * @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
+type Colorize = (text: string, defaultColor?: string | number) => string
 
 /** Colorer is a little too fancy. Hence the gnarly typescript. */
 type Colorer = {
-  (text: string, def?: string | number): string
+  (text: string, defaultColor?: string | number): string
   black: Colorize
   command: Colorize
   default: Colorize
@@ -34,72 +31,3 @@ type GameNote = {
 
 /** 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/version.js

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

package/.rgignore

@@ -1,2 +0,0 @@
-node_modules
-package-lock.json