@slugbugblue/trax 0.9.0 → 0.10.2

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @slugbugblue/trax
 
+## 0.10.1 - 0.10.2 - 2022-06-12
+
+- Added an entry point for the `Point` class at `@slugbugblue/trax/point`
+
+## 0.10.0 - 2022-06-12
+
+- Added `point.in(topLoft, bottomRight)` to see if a point is inside a
+  rectangular bounded area
+- Minor coding style changes due to updated `xo` rules
+
 ## 0.9.0 - 2022-04-24
 
 - Added tab-completion and completion preview code to the interactive CLI

package/README.md

@@ -117,11 +117,9 @@ puzzle.play('@2\\')
 
 For specifics, see the [engine.js documentation][engine-docs].
 
-## Roadmap
+## Related Projects
 
-- Game position analysis
-- Bot
-- Puzzles
+- [TraxBot][traxbot]: Game position analysis and puzzlebot
 
 ## Support
 
@@ -142,11 +140,11 @@ Thanks to his widow Colleen Foley-Smith for extending that courtesy to allow me
 to include Trax on [slugbugblue.com][sbb] as well.
 
 I would also like to extend a huge heartfelt appreciation to the magnanimous
-[Donald G. Bailey][dgb], who, through his excellent [book][traxbook], taught me
-the basics (and more!) of Trax. I found him always ready to share his insights
-on the mechanics of the game, as well as various approaches to encoding its
-complexities. His undeserved kindness and infinite patience in indulging my many
-questions can never be repaid.
+[Donald G. Bailey][dgb], who, through his excellent book [Trax Strategy for
+Beginners][traxbook], taught me the basics (and more!) of Trax. I found him
+always ready to share his insights on the mechanics of the game, as well as
+various approaches to encoding its complexities. His undeserved kindness and
+infinite patience in indulging my many questions can never be repaid.
 
 ## License
 
@@ -165,7 +163,7 @@ specific language governing permissions and limitations under the License.
 
 ## Trax rules copyright
 
-In the United States, game mechanics are not eligible for coyright protection;
+In the United States, game mechanics are not eligible for copyright protection;
 however, the specific wording of game rules does fall under copyright law.
 
 The official rules for Trax are found at http://traxgame.com/about_rules.php.
@@ -181,6 +179,7 @@ David Smith and heirs, and are not to be used without permission.
 [repo]: https://gitlab.com/slugbugblue/trax
 [sbb]: https://slugbugblue.com/
 [traxbook]: http://traxgame.com/shop_book.php
+[traxbot]: https://gitlab.com/slugbugblue/traxbot
 [traxgame]: http://traxgame.com/
 [xdg]:
   https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html

package/docs/point.md

@@ -85,6 +85,13 @@ Returns the distance between two points. This will never be a negative number.
 Returns `true` if the given point or point-like object is at the same location
 as the existing point.
 
+##### `in(topLeft, bottomRight)`
+
+Pass in two points (or point-like objects) to define a rectangular bounding box.
+
+Returns `true` if the calling point is located inside the box or along any of
+its edges (ie, both bounding points are considered "inside").
+
 #### Plays well with others
 
 The Point class also includes functionality to provide useful default results

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slugbugblue/trax",
-  "version": "0.9.0",
+  "version": "0.10.2",
   "description": "Trax game engine and friends",
   "keywords": [
     "trax",
@@ -11,7 +11,10 @@
   "bugs": "https://gitlab.com/slugbugblue/trax/issues",
   "license": "Apache-2.0",
   "author": "Chad Transtrum <chad@transtrum.net>",
-  "exports": "./src/engine.js",
+  "exports": {
+    ".": "./src/engine.js",
+    "./point.js": "./src/point.js"
+  },
   "repository": "gitlab:slugbugblue/trax",
   "bin": {
     "trax": "./src/cli.js"
@@ -31,7 +34,7 @@
     "c8": "^7.11.0",
     "genversion": "^3.0.2",
     "prettier": "^2.6.1",
-    "xo": "^0.48.0"
+    "xo": "0.*"
   },
   "type": "module",
   "engines": {

package/src/cli.js

@@ -485,7 +485,7 @@ const expand = (completions, match) => {
 }
 
 const completer = (line) => {
-  const words = line.split(/\s+/).filter((w) => w)
+  const words = line.split(/\s+/).filter(Boolean)
 
   let match = words.slice(-1)[0] || ''
   const previous = new Set(words.slice(1, -1).map((s) => s.toLowerCase()))
@@ -541,7 +541,7 @@ const completer = (line) => {
 }
 
 const evaluate = async (command) => {
-  const [CMD, ...words] = command.split(/\s+/).filter((c) => c)
+  const [CMD, ...words] = command.split(/\s+/).filter(Boolean)
   const cmdLower = CMD.toLowerCase()
   CLI.CMD = cmdLower
   const cmd = abbreviations[cmdLower]

package/src/cmds/import-export.js

@@ -162,7 +162,7 @@ importCmd.fn = async (CLI, filename) => {
         if (lower.includes('loop')) game = 'traxloop'
         if (lower.includes('8x8')) game = 'trax8'
       } else if (players.length === 0 && lower.includes(' vs ')) {
-        players = ln.split(' ').filter((p) => p)
+        players = ln.split(' ').filter(Boolean)
       } else {
         moves.push(...ln.split(' '))
       }
@@ -170,7 +170,7 @@ importCmd.fn = async (CLI, filename) => {
 
     if (game) {
       CLI.do('new', game, ...players)
-      CLI.do('play', ...moves.filter((m) => m))
+      CLI.do('play', ...moves.filter(Boolean))
     } else {
       CLI.error(filename + ' does not appear to be formatted correctly.')
     }

package/src/point.js

@@ -23,6 +23,8 @@ export const Point = class {
   #x = 0
   #y = 0
 
+  static dirs = ['up', 'down', 'left', 'right']
+
   constructor(x, y) {
     if (is(x, 'obj') && is(x.x, 'num') && is(x.y, 'num')) {
       // You can call this with new Point(point) or new Point({x,y})
@@ -76,6 +78,7 @@ export const Point = class {
   dir(direction) {
     const error = 'direction must be one of: up, down, left, right, u, d, l, r'
     if (!is(direction, 'str')) throw new SyntaxError(error)
+    direction = direction.toLowerCase()
     if (direction[0] === 'u') return this.up
     if (direction[0] === 'd') return this.down
     if (direction[0] === 'l') return this.left
@@ -99,6 +102,15 @@ export const Point = class {
     return this.#x === that.x && this.#y === that.y
   }
 
+  in(topLeft, bottomRight) {
+    return (
+      this.x >= topLeft.x &&
+      this.x <= bottomRight.x &&
+      this.y >= topLeft.y &&
+      this.y <= bottomRight.y
+    )
+  }
+
   // Play nicely with the rest of the world
 
   toString() {

package/src/version.js

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