cm-chess 2.1.4 → 2.1.8

package/README.md

@@ -1,7 +1,7 @@
 # cm-chess 
 
 It is like [chess.js](https://github.com/jhlywa/chess.js), 
-but is an ES6 module, can handle history variants (tree-structured move history), 
+but is an ES6 module, can handle history variations (tree-structured move history), 
 PGN header values, Nags and Comments.
 
 ## Install
@@ -11,9 +11,9 @@ PGN header values, Nags and Comments.
 ## Features
 
 - It has a similar API to chess.js
-- It can handle history variants
+- It can handle history variations
 - It can add Nags, Comments and Annotations
-- It is used by the 7,000 users from [chessmail](https://www.chessmail.eu) (it works)
+- It is used by the 7,000 users of [chessmail](https://www.chessmail.de) (it works)
 
 ## API
 

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "cm-chess",
-  "version": "2.1.4",
-  "description": "Like chess.js, but in ES6 and can handle variants (tree-structured move history)",
-  "main": "index.html",
+  "version": "2.1.8",
+  "description": "Like chess.js, but in ES6 and can handle variations (tree-structured move history)",
+  "main": "./src/cm-chess/Chess.js",
   "scripts": {
     "test": "mocha --require babel-core/register ./test/*.js",
     "postinstall": "node postinstall.js"

package/src/cm-chess/Chess.js

@@ -32,8 +32,18 @@ export const FEN = {
  */
 export class Chess {
 
-    constructor(fen = FEN.start) {
-        this.load(fen)
+    constructor(fenOrProps = FEN.start) {
+        if(typeof fenOrProps === "string") {
+            this.load(fenOrProps)
+        } else {
+            if(fenOrProps.fen) {
+                this.load(fenOrProps.fen)
+            } else if(fenOrProps.pgn) {
+                this.loadPgn(fenOrProps.pgn)
+            } else {
+                this.load(FEN.start)
+            }
+        }
     }
 
     /**
@@ -162,7 +172,7 @@ export class Chess {
     }
 
     /**
-     * Load a PGN with variants, NAGs, header and annotations. cm-chess uses cm-pgn
+     * Load a PGN with variations, NAGs, header and annotations. cm-chess uses cm-pgn
      * fot the header and history. See https://github.com/shaack/cm-pgn
      * @param pgn
      */
@@ -173,7 +183,7 @@ export class Chess {
     /**
      * Make a move in the game.
      * @param move
-     * @param previousMove optional, the previous move (variants)
+     * @param previousMove optional, the previous move (for variations)
      * @param sloppy to allow sloppy SAN
      * @returns {{}|undefined}
      */
@@ -190,7 +200,7 @@ export class Chess {
      * @returns {string} the PGN of the game.
      */
     renderPgn() {
-        // TODO create pgn with variants, annotations, nags (for now just render main variant)
+        // TODO create pgn with variations, annotations, nags (for now just render main variant)
         const chess = new ChessJs(this.setUpFen())
         const moves = this.pgn.history.moves
         for (const move of moves) {
@@ -271,4 +281,4 @@ export class Chess {
     }
 
 
-}
+}

package/test/TestChess.js

@@ -2,7 +2,7 @@ import {Chess, COLOR, FEN} from "../src/cm-chess/Chess.js"
 import {TAGS} from "../lib/cm-pgn/Header.js"
 import {describe, it, assert} from "../node_modules/teevi/src/teevi.js"
 
-// TODO create a test, which demonstrates all features, including variants
+// TODO create a test, which demonstrates all features, including variations
 
 describe("Chess", function () {
 
@@ -13,26 +13,25 @@ describe("Chess", function () {
         assert.equals(chess.fen(), FEN.start)
     })
 
-    it("should load a game from FEN", function() {
+    it("should load a game from FEN", function () {
         const fen = "4k3/pppppppp/8/8/8/8/PPPPPPPP/4K3 w - - 0 1"
         const chess = new Chess(fen)
         assert.equals(chess.pgn.header.tags[TAGS.FEN], fen)
         assert.equals(chess.fen(), fen)
     })
 
-    it("should load a pgn with SetUp and FEN", function() {
+    it("should load a pgn with SetUp and FEN", function () {
         const pgn = `[SetUp "1"]
 [FEN "4k3/pppppppp/8/8/8/8/PPPPPPPP/4K3 w - - 0 1"]
 
 1. e4 (1. d4 {Die Variante} d5) e5 {Ein Kommentar} 2. a3`
-        const chess = new Chess()
-        chess.loadPgn(pgn)
+        const chess = new Chess({pgn: pgn})
         assert.equals(chess.move("Nc6"), undefined)
         const result = chess.move("h6")
         assert.equals(result.fen, "4k3/pppp1pp1/7p/4p3/4P3/P7/1PPP1PPP/4K3 w - - 0 3")
     })
 
-    it("should load a pgn", function() {
+    it("should load a pgn", function () {
         const chess = new Chess()
         const pgn = `[Event "IBM Kasparov vs. Deep Blue Rematch"]
 [Site "New York, NY USA"]
@@ -59,7 +58,6 @@ describe("Chess", function () {
     })
 
     it("should load a pgn with SetUp", () => {
-        const chess = new Chess()
         const pgn = `[Event "?"]
 [White "?"]
 [Black "?"]
@@ -69,7 +67,7 @@ describe("Chess", function () {
 
 1. Qc1 Qe6 2. Qxc7 
 0-1`
-        chess.loadPgn(pgn)
+        const chess = new Chess({pgn: pgn})
         assert.equals(chess.history()[2].san, "Qxc7")
     })
 
@@ -89,7 +87,7 @@ describe("Chess", function () {
 
 1... Bf8 (1... Qf8? 2. Qxf8+ Bxf8 3. exd4) 2. exd4 Qxd4+ {%Q} 3. Kh1 Bh3 
 0-1`
-        chess.loadPgn(pgn, {}, true)
+        chess.loadPgn(pgn)
         assert.equals(5, chess.pgn.history.moves.length)
         assert.equals("Schaak opheffen", chess.pgn.header.tags[TAGS.White])
         assert.equals("app 037-1", chess.pgn.header.tags[TAGS.Annotator])
@@ -185,7 +183,7 @@ describe("Chess", function () {
         assert.equals(chess.fenOfPly(3), "8/8/b2Bq3/8/4p3/3k1pP1/2Q5/3K4 b - - 3 2")
     })
 
-    it("should not load incorrect FEN", function() {
+    it("should not load incorrect FEN", function () {
         const fen = "4k3/pppppppp/8/8/8/8/PPPPPP/4K3 w - - 0 1"
         try {
             new Chess(fen)
@@ -202,13 +200,13 @@ describe("Chess", function () {
         }
     })
 
-    it("should load different PGNs and then work correctly", function() {
+    it("should load different PGNs and then work correctly", function () {
         const fen = "ppppkppp/pppppppp/pppppppp/pppppppp/8/8/8/RNBQKBNR w KQ - 0 1"
-        const chess = new Chess(fen)
+        const chess = new Chess({fen: fen})
         assert.true(chess.move("e4") === undefined)
         assert.true(chess.move("Ke2") !== undefined)
         chess.load(FEN.start)
         assert.true(chess.move("e4"))
     })
 
-})
+})