@slugbugblue/trax 0.15.0 → 0.16.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @slugbugblue/trax
 
+## 0.16.0 - 2022-12-27
+
+- Added a `notes` command to the CLI to add comments to a game
+
+  - can be used as a text filter by the `list` command
+  - will be displayed by the `view` command
+  - will be included in the output generated by the `export` command
+
+- Minor analysis improvements
+
 ## 0.15.0 - 2022-12-14
 
 - Added shared `puzzles` commands to the CLI:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slugbugblue/trax",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "Trax game engine and friends",
   "keywords": [
     "trax",

package/src/analyst.js

@@ -379,7 +379,7 @@ export const Analysis = class {
       const calcLevel = level > 0 && defending ? level + threatLevel - 1 : level
       let points = attackScore(inactive, level, calc ? calcLevel : 0)
       if (level === threatLevel) points = passive ? Math.floor(points / 2) : 0
-      if (threatening) points = Math.floor(points / 2)
+      if (passive && threatening) points = Math.floor(points / 2)
       score += points
     }
 

package/src/cli.js

@@ -38,6 +38,7 @@ import {
 } from './cmds/import-export.js'
 import { listCmd } from './cmds/list.js'
 import { newCmd } from './cmds/new.js'
+import { notesCmd } from './cmds/notes.js'
 import { playCmd, tryCmd } from './cmds/play-try.js'
 import { puzzlesCmd } from './cmds/puzzles.js'
 import { selectCmd } from './cmds/select.js'
@@ -87,6 +88,7 @@ const plugins = [
   importCmd,
   listCmd,
   newCmd,
+  notesCmd,
   playCmd,
   puzzlesCmd,
   quitCmd,
@@ -197,14 +199,6 @@ const DATA = { games: {}, puzzles: {} }
 
 // CLI context object for plugins
 const CLI = {
-  // Notation manipulation
-  fixNotation(move) {
-    if (move.endsWith('b')) return move.slice(0, -1) + '\\'
-    if (move.endsWith('s')) return move.slice(0, -1) + '/'
-    if (move.endsWith('p')) return move.slice(0, -1) + '+'
-    return move
-  },
-
   // Quick access to all stored games
   get GAMES() {
     return DATA.games || {}
@@ -283,6 +277,28 @@ const CLI = {
     CLI.out(CLI.color.error(text))
   },
 
+  // Notation manipulation
+  fixNotation(move) {
+    if (move.endsWith('b')) return move.slice(0, -1) + '\\'
+    if (move.endsWith('s')) return move.slice(0, -1) + '/'
+    if (move.endsWith('p')) return move.slice(0, -1) + '+'
+    return move
+  },
+
+  load(id) {
+    if (!id) id = Object.keys(DATA.games || {})[0]
+    if (id && DATA.games?.[id] && DATA.games[id].rules) {
+      if (id !== String(CONFIG.id)) {
+        CONFIG.id = id
+        saveConfig()
+      }
+
+      const game = CLI.GAME
+      if (!game.players) game.players = ['white', 'black']
+      CLI.TRAX = new Trax(game.rules, game.moves, 'cli')
+    }
+  },
+
   newGame(rules, players, moves) {
     // Creates a new game
     const id = newId(DATA)
@@ -367,6 +383,11 @@ const CLI = {
     return undefined
   },
 
+  /** Write out the current data to disk. */
+  save() {
+    saveData()
+  },
+
   setGame(moves) {
     // Updates the moves for the current game
     const game = CLI.GAME
@@ -390,20 +411,6 @@ const CLI = {
     }
   },
 
-  load(id) {
-    if (!id) id = Object.keys(DATA.games || {})[0]
-    if (id && DATA.games?.[id] && DATA.games[id].rules) {
-      if (id !== String(CONFIG.id)) {
-        CONFIG.id = id
-        saveConfig()
-      }
-
-      const game = CLI.GAME
-      if (!game.players) game.players = ['white', 'black']
-      CLI.TRAX = new Trax(game.rules, game.moves, 'cli')
-    }
-  },
-
   // Pass through functions
   bubble: tty.bubble,
   display: tty.display,

package/src/cmds/import-export.js

@@ -188,6 +188,63 @@ importCmd.fn = async (CLI, filename) => {
   }
 }
 
+/** Get all the notes for a certain move.
+ * @arg {number} move - The move number
+ * @arg {GameNotes} notes? - The notes for a game
+ * @returns {string} - Notes formatted for this move, or empty string if none
+ */
+const gameNotes = (move, notes) => {
+  notes = notes || []
+  const moveNotes = notes.filter((n) => n.move === move)
+  if (moveNotes.length === 0) return ''
+  return (
+    '; ' +
+    moveNotes.map((n) => n.note.replaceAll('\n', '\n; ')).join('\n; ') +
+    '\n'
+  )
+}
+
+/** Interleave the game moves with any notes, formatted for the export file.
+ * @arg {string[]} moves - an array of move notations
+ * @arg {GameNotes} notes? - The notes for a game
+ * @returns {string} - A string that can be placed into an export file
+ */
+const interleaveNotation = (moves, notes) => {
+  let content = ''
+  let moveNumber = 0
+  let annotation = ''
+  for (const move of moves) {
+    const comments = gameNotes(moveNumber, notes)
+    if (comments) {
+      const [lengthA, lengthC] = [annotation.length, comments.length]
+      const space = lengthA > 0 ? (lengthA + lengthC < 78 ? ' ' : '\n') : ''
+      content += space + annotation + comments
+      annotation = ''
+    }
+
+    moveNumber += 1
+    const notation = String(moveNumber) + '. ' + move
+    if (annotation.length + notation.length < 79) {
+      annotation += (annotation.length > 0 ? ' ' : '') + notation
+    } else {
+      content += '\n' + annotation
+      annotation = notation
+    }
+  }
+
+  const comments = gameNotes(moveNumber, notes)
+  if (comments) {
+    const [lengthA, lengthC] = [annotation.length, comments.length]
+    const space = lengthA > 0 ? (lengthA + lengthC < 78 ? ' ' : '\n') : ''
+    content += space + annotation + comments
+    annotation = ''
+  }
+
+  content += annotation
+  if (!content.endsWith('\n')) content += '\n'
+  return content
+}
+
 exportCmd.fn = (CLI, id, filename) => {
   cli = CLI
   let game = CLI.GAME
@@ -218,7 +275,7 @@ exportCmd.fn = (CLI, id, filename) => {
       content += '; Puzzle ' + game.puzzle
       if (source) {
         content += ' provided courtesy of ' + source.name
-        if (source.url) content += ' (' + source.url + ')'
+        if (source.url) content += '\n; ' + source.url
       }
 
       if (puzzle.title) content += '\n; ' + puzzle.title
@@ -230,7 +287,8 @@ exportCmd.fn = (CLI, id, filename) => {
     }
   }
 
-  content += trax.notation + '\n'
+  content += interleaveNotation(trax.moves, game.notes)
+
   if (filename) filename = filename.replace(/[^ a-z\d.~/]/g, '')
   if (filename) {
     const fname = filename.split('/').pop()

package/src/cmds/list.js

@@ -15,6 +15,8 @@
 
 // CLI list command
 
+import process from 'node:process'
+
 import { Trax } from '@slugbugblue/trax'
 
 export const listCmd = {
@@ -35,7 +37,7 @@ export const listCmd = {
     '  #id: match a game or a certain number of moves',
     '  "active" or "over": whether a game is in progress or not',
     '  "loop" or "8x8" or "trax": filter by game type',
-    "  <other text>: match a player's name",
+    "  <other text>: match a player's name or the latest game note",
     'Add the "reverse" option to reverse the sort order.',
   ],
 }
@@ -80,14 +82,16 @@ const listSort = (list, filters) => {
     } else if (['over', 'active'].includes(by)) {
       list = list.filter((g) => (by === 'over' ? g.over : !g.over))
     } else {
-      list = list.filter(
-        (g) =>
+      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.moves.startsWith(by + ' ') ||
+          g.note.includes(by)
+        )
+      })
     }
   }
 
@@ -96,6 +100,19 @@ 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
+ */
+const leftover = (sizes) => {
+  let left = process.stdout.columns
+  for (const size of Object.values(sizes)) {
+    left -= size
+  }
+
+  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.')
@@ -106,12 +123,14 @@ listCmd.fn = (CLI, ...filters) => {
 
   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
@@ -120,13 +139,14 @@ listCmd.fn = (CLI, ...filters) => {
       id: (game.id === CLI.GAME.id ? '* #' : '#') + String(game.id),
       name: game.name?.length || 0,
       rules: game.rules,
-      moves: CLI.plural(moves, 'move'),
+      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 || '',
     })
   }
 
@@ -138,6 +158,7 @@ listCmd.fn = (CLI, ...filters) => {
     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) {
@@ -149,7 +170,8 @@ listCmd.fn = (CLI, ...filters) => {
         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.over ? 'game over' : game.moves),
+        CLI.color(game.moves.padEnd(size.moves)) +
+        CLI.color.help(' ' + game.note.slice(0, noteSize)),
     )
   }
 }

package/src/cmds/notes.js

@@ -0,0 +1,34 @@
+/** Notes CLI command.
+ * @copyright 2022
+ * @author Chad Transtrum <chad@transtrum.net>
+ * @license Apache-2.0
+ */
+
+export const notesCmd = {
+  name: 'notes',
+  args: '[#id] <text>',
+  desc: 'add a note to a game',
+  help: [
+    '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)
+  if (!id) id = current
+  if (!/^#?\d+$/.test(id)) {
+    note.unshift(id)
+    id = current
+  }
+
+  if (id.startsWith('#')) id = id.slice(1)
+
+  const game = CLI.GAMES[id]
+  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()
+}

package/src/cmds/view.js

@@ -39,7 +39,10 @@ viewCmd.fn = (CLI, move) => {
     show = Number(move)
   }
 
-  const players = CLI.GAME.players || ['white', 'black']
+  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 + ' ') +
@@ -50,4 +53,6 @@ viewCmd.fn = (CLI, move) => {
       CLI.bubble('b' + (trax.turn === 2 ? 'h' : ''), players[1]),
   )
   CLI.display(trax, players, undefined, show)
+  if (puzzle) CLI.out(CLI.color('Puzzle ' + puzzle))
+  if (note) CLI.out(CLI.color.help(note))
 }

package/src/engine.js

@@ -617,7 +617,7 @@ export const Trax = class {
     return this.notation
       .replace(/\n/g, ' ')
       .split(' ')
-      .filter((n) => !n.endsWith('.'))
+      .filter((n) => Boolean(n) && !n.endsWith('.'))
   }
 
   /** Drop a tile onto the board. This is a lower level call. Use play() if possible instead.

package/src/threats.js

@@ -198,4 +198,5 @@ for (const one of Object.keys(corners)) {
 threats.add(3, 'ralbmrW') // Attack into a wide cave
 threats.add(3, 'Arlbmwr') // Reversed
 
+threats.add(4, 'rb¡c?w!br') // Connectable pair on an edge
 threats.add(4, 'ArlbmrW') // Wide cave ready for an attack

package/src/types.d.ts

@@ -62,6 +62,15 @@ type FoundThreats = Record<string, FoundThreat[]>
 /** All the threats found for both the white and black player. */
 type FoundThreatsCollection = { b: ColorThreats; w: ColorThreats }
 
+/** A note with a move number */
+type GameNote = {
+  move: number
+  note: string
+}
+
+/** Notes saved in the game object in the CLI. */
+type GameNotes = GameNote[]
+
 /** A point-like object has numerical x and y properties. */
 type PointLike = {
   x: number

package/src/version.js

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