@slugbugblue/trax 0.16.0 → 0.17.0

package/CHANGELOG.md

@@ -1,12 +1,16 @@
 # @slugbugblue/trax
 
+## 0.17.0 - 2022-12-29
+
+- The `import` CLI command now loads comments from a .trx file
+
 ## 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
+  - 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
 
 - Minor analysis improvements
 

package/README.md

@@ -13,7 +13,7 @@ Trax is a two-player boardless board game invented by David Smith. For more
 information about Trax, including its [rules][traxrules] and
 [history][traxhistory], see the official website at [traxgame.com][traxgame].
 
-This goal of this javascript project is to allow Trax to be played
+The goal of this javascript project is to allow Trax to be played
 programmatically. It can be used as an engine in a web browser, for example at
 [slugbugblue.com][sbb]; or in nodejs, for example by using the `trax` CLI
 provided as part of this project.
@@ -27,7 +27,7 @@ changes to the engine should meet the same standard.
 # Install into a javascript project
 npm install @slugbugblue/trax
 
-# Or install globally to use the trax CLI
+# Or install globally to use the trax CLI more easily
 npm install -g @slugbugblue/trax
 ```
 
@@ -43,11 +43,12 @@ avoid worries about the need to escape certain characters from the shell, and it
 can be easier to run multiple commands back to back.
 
 Help is available for the CLI through the use of the `help` command. Type
-`trax help` to see a list of the available commands, and `trax help play` to see
-information about the `play` command. Aliases and abbreviations are provided to
-minimize typing and to try to avoid the requirement of memorizing the commands.
-For example, the `list` command has an alias of `ls`, and the `select` command
-can be activated using `#`.
+`trax help` (or `npx trax help` with a local installation, or simply `help` if
+run interactively) to see a list of the available commands, and `trax help play`
+to see information about the `play` command. Aliases and abbreviations are
+provided to minimize typing and to try to avoid the requirement of memorizing
+the commands. For example, the `list` command has an alias of `ls`, and the
+`select` command can be activated using `#`.
 
 When you first launch the CLI, you can create a new game using the `new`
 command, and then enter moves for that game using `play`. Since `play` is likely

package/package.json

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

package/src/cmds/import-export.js

@@ -137,6 +137,79 @@ export const exportCmd = {
   ],
 }
 
+/** Interpret the rules string of a .trx file.
+ * @arg {string} r - rules string in lower case
+ * @returns {TraxVariant}
+ */
+const getRules = (r) =>
+  r.includes('loop') ? 'traxloop' : r.includes('8x8') ? 'trax8' : 'trax'
+
+/** Decode a .trx formatted string into a game, preserving players and comments.
+ * @arg {any} CLI - the CLI object
+ * @arg {string} content - the contents of the .trx file
+ * @returns {boolean} - true if a game was created
+ */
+const interpretFile = (CLI, content) => {
+  let rules
+  let trax
+  let players = []
+  const moves = []
+  const comments = []
+  for (const line of content.split('\n')) {
+    if (!line) continue
+    const [ln, ...comment] = line.split(/[#;]/)
+    if (ln) {
+      const lower = ln.toLowerCase()
+      if (!rules && lower.includes('trax')) {
+        rules = getRules(lower)
+      } else if (players.length === 0 && lower.includes(' vs ')) {
+        players = ln.split(' ').filter(Boolean)
+      } else {
+        moves.push(...ln.split(' '))
+      }
+    }
+
+    if (!trax && rules && (players.length > 0 || moves.length > 0)) {
+      trax = new Trax(rules)
+    }
+
+    if (moves.length > 0) {
+      if (!trax) return false
+      if (trax.gameOver) {
+        comments.push({
+          note: moves.map((c) => c.trim()).join(' '),
+          move: trax.move,
+        })
+      } else {
+        trax.playMoves(moves.filter(Boolean))
+        moves.splice(0, moves.length)
+      }
+    }
+
+    if (comment.length > 0) {
+      const note = comment.map((c) => c.trim()).join(' ')
+      if (!/^@slugbugblue\/trax cli\.js v/.test(note)) {
+        comments.push({
+          note,
+          move: trax?.move || 0,
+        })
+      }
+    }
+  }
+
+  if (!trax) return false
+
+  CLI.do('new', rules, ...players)
+  CLI.GAMES[String(CLI.GAME.id)].notes = comments
+  if (trax.moves.length > 0) {
+    CLI.do('play', ...trax.moves)
+  } else {
+    CLI.save()
+  }
+
+  return true
+}
+
 importCmd.fn = async (CLI, filename) => {
   cli = CLI
   if (!filename) {
@@ -156,35 +229,11 @@ importCmd.fn = async (CLI, filename) => {
       }
     }
 
-    if (!content) CLI.error(fsError.toString())
+    if (!content) return CLI.error(fsError.toString())
   }
 
-  if (content) {
-    let game
-    let players = []
-    const moves = []
-    for (const line of content.split('\n')) {
-      if (!line) continue
-      const ln = line.split(/[#;]/)[0]
-      if (!ln) continue
-      const lower = ln.toLowerCase()
-      if (!game && lower.includes('trax')) {
-        game = 'trax'
-        if (lower.includes('loop')) game = 'traxloop'
-        if (lower.includes('8x8')) game = 'trax8'
-      } else if (players.length === 0 && lower.includes(' vs ')) {
-        players = ln.split(' ').filter(Boolean)
-      } else {
-        moves.push(...ln.split(' '))
-      }
-    }
-
-    if (game) {
-      CLI.do('new', game, ...players)
-      CLI.do('play', ...moves.filter(Boolean))
-    } else {
-      CLI.error(filename + ' does not appear to be formatted correctly.')
-    }
+  if (!interpretFile(CLI, content)) {
+    CLI.error(filename + ' does not appear to be formatted correctly.')
   }
 }
 
@@ -204,6 +253,15 @@ const gameNotes = (move, notes) => {
   )
 }
 
+/** Join two strings together with a character with the appropriate joining
+ * character depending on the length of the strings.
+ * @arg {string} a - the first string
+ * @arg {string} b - the second string
+ * @returns {string} - both strings correctly joined
+ */
+const join = (a, b) =>
+  a.length === 0 ? b : a.length + b.length > 78 ? a + '\n' + b : a + ' ' + b
+
 /** 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
@@ -216,9 +274,7 @@ const interleaveNotation = (moves, notes) => {
   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
+      content += join(annotation, comments)
       annotation = ''
     }
 
@@ -234,9 +290,7 @@ const interleaveNotation = (moves, notes) => {
 
   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
+    content += join(annotation, comments)
     annotation = ''
   }
 

package/src/cmds/play-try.js

@@ -142,7 +142,7 @@ playCmd.fn = (CLI, ...moves) => {
 }
 
 tryCmd.fn = (CLI, move) => {
-  if (move.length === 0) {
+  if (!move || move.length === 0) {
     CLI.error('You must provide a move.')
     return CLI.do('help', 'try')
   }

package/src/version.js

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