schachnovelle 1.1.0 → 1.1.2

package/README.md

@@ -4,8 +4,8 @@ _»Um Gottes Willen! Nicht!«_
 [![Find the code on GitLab](https://upload.wikimedia.org/wikipedia/commons/d/d9/Chess_clt45.svg)](https://gitlab.com/manegame/schachnovelle)
 
 
+_[manusnijhoff.nl](https://manusnijhoff.nl)_,
 _[Read the book](https://en.wikipedia.org/wiki/The_Royal_Game)_, _[Play me on lichess](https://lichess.org/@/manegame)_,
-_[Check out my website](https://manusnijhoff.nl)_
 
 
 ## Installation
@@ -23,13 +23,11 @@ or npm
 ...And play!
 
 ## Features
-There is no check detection yet. Play with your head! For now...
-
 You can play against yourself or a friend on the same keyboard.
 
 ## Roadmap
 
-I'm slowly working on connecting this to the [lichess](https://lichess.org/) API, so you can play others from the comfort of the command line!
+I'd love to connect this to the [lichess](https://lichess.org/) API, so you can play others from the comfort of the command line!
 
 ## Changelog
 

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "schachnovelle",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Chess to play on the command line",
   "main": "index.js",
+  "exports": {
+    ".": "./index.js",
+    "./web": "./web.js"
+  },
   "scripts": {
     "play": "node index.js",
     "serve": "node server/index.js"

package/ui/Board.js

@@ -1,6 +1,4 @@
-const chalk = require('chalk')
-
-const Printer = require('./Printer')
+const plainChalk = require('./plainChalk')
 const Utils = require('./Utils')
 
 const files = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h']
@@ -20,7 +18,11 @@ class Board {
       this.ranks = ranks
     }
 
-    this.printer = new Printer(options.spacing)
+    this.chalk = options.chalk || plainChalk
+    if (!options.printer) {
+      throw new Error('Board requires a printer instance via options.printer')
+    }
+    this.printer = options.printer
     this.utils = new Utils()
   }
 
@@ -45,9 +47,9 @@ class Board {
     })
     if (this.options.mode === 'color') {
       if (activeWhitePiece) {
-        return chalk` {whiteBright ${activeWhitePiece.piece}} `
+        return this.chalk` {whiteBright ${activeWhitePiece.piece}} `
       } else if (activeBlackPiece) {
-        return chalk` {black ${activeBlackPiece.piece}} `
+        return this.chalk` {black ${activeBlackPiece.piece}} `
       }
       return `   `
     } else if (this.options.mode === 'bare') {
@@ -56,15 +58,15 @@ class Board {
        */
       if (activeWhitePiece) {
         if (activeWhitePiece.type === 'King' && this.white.inCheck) {
-          return chalk`{red ${activeWhitePiece.piece}}  `
+          return this.chalk`{red ${activeWhitePiece.piece}}  `
         } else {
-          return chalk`{black ${activeWhitePiece.piece}}  `
+          return this.chalk`{black ${activeWhitePiece.piece}}  `
         }
       } else if (activeBlackPiece) {
         if (activeBlackPiece.type === 'King' && this.black.inCheck) {
-          return chalk`{red ${activeBlackPiece.piece}}  `
+          return this.chalk`{red ${activeBlackPiece.piece}}  `
         } else {
-          return chalk`{black ${activeBlackPiece.piece}}  `
+          return this.chalk`{black ${activeBlackPiece.piece}}  `
         }
       }
       /**
@@ -74,9 +76,9 @@ class Board {
       const rankParity = this.ranks.indexOf(rank) % 2 === 0 // the rank is odd
       const fileParity = this.files.indexOf(file) % 2 === 0 // the file is odd
       if (rankParity && fileParity || !rankParity && !fileParity) {
-        return chalk`{white .}  `
+        return this.chalk`{white .}  `
       } else {
-        return chalk`{black .}  `
+        return this.chalk`{black .}  `
       }
     }
   }
@@ -174,16 +176,16 @@ class Board {
           // if rank is even, start with white
           if (rank % 2 === 0) {
             if (file % 2 === 0) {
-              renderRank += chalk.bgKeyword('darkgrey')(this.getPiece(this.files[file], this.ranks[rank]))
+              renderRank += this.chalk.bgKeyword('darkgrey')(this.getPiece(this.files[file], this.ranks[rank]))
             } else {
-              renderRank += chalk.bgBlackBright(this.getPiece(this.files[file], this.ranks[rank]))
+              renderRank += this.chalk.bgBlackBright(this.getPiece(this.files[file], this.ranks[rank]))
             }
             renderRank = this.printer.addSpace('x', renderRank)
           } else {
             if (file % 2 === 0) {
-              renderRank += chalk.bgBlackBright(this.getPiece(this.files[file], this.ranks[rank]))
+              renderRank += this.chalk.bgBlackBright(this.getPiece(this.files[file], this.ranks[rank]))
             } else {
-              renderRank += chalk.bgKeyword('darkgrey')(this.getPiece(this.files[file], this.ranks[rank]))
+              renderRank += this.chalk.bgKeyword('darkgrey')(this.getPiece(this.files[file], this.ranks[rank]))
             }
             renderRank = this.printer.addSpace('x', renderRank)
           }
@@ -208,4 +210,4 @@ class Board {
   }
 }
 
-module.exports = Board
+module.exports = Board

package/ui/Game.js

@@ -1,13 +1,14 @@
-const readline = require("readline")
+
 const Side = require("./Side")
 const Board = require("./Board")
-const Printer = require("./Printer")
 const Utils = require("./Utils")
 
-const Enquirer = require("enquirer")
-
 class Game {
   constructor(options) {
+    if (!options || !options.enquirer || typeof options.enquirer.prompt !== 'function') {
+      throw new Error('Game requires an enquirer-like instance via options.enquirer')
+    }
+
     this.white = new Side("white")
     this.black = new Side("black")
     this.playingAs = options.playingAs
@@ -20,14 +21,14 @@ class Game {
 
     // Initialize the board
     this.board = new Board(this.white, this.black, {
-      mode: "pieces", // possibly add text mode
+      mode: options.mode || "pieces", // possibly add text mode
       orientation: this.playingAs,
       spacing: options.spacing,
-      mode: options.mode,
+      printer: options.printer,
+      chalk: options.chalk
     })
 
-    this.enquirer = new Enquirer()
-    this.printer = new Printer(options.spacing)
+    this.enquirer = options.enquirer
     this.utils = new Utils()
   }
 

package/ui/WebPrinter.js

@@ -0,0 +1,51 @@
+class WebPrinter {
+  constructor (spacing, io) {
+    this.spacing = spacing
+    this.io = io
+    this.tab = '   '
+    this.lineCount = 0
+  }
+
+  clearView () {
+    if (this.io && this.io.clear) {
+      this.io.clear()
+    }
+  }
+
+  clearForward () {}
+
+  printLine (value) {
+    if (this.io && this.io.write) {
+      this.io.write(value + '\n')
+      this.lineCount++
+    }
+  }
+
+  print (value) {
+    if (this.io && this.io.write) {
+      this.io.write(value)
+    }
+  }
+
+  addSpace (direction, string) {
+    if (direction === 'x') {
+      for (let i = 0; i < this.spacing; i++) {
+        string += ' '
+      }
+    } else {
+      for (let i = 0; i < this.spacing; i++) {
+        this.printLine('')
+      }
+    }
+    return string
+  }
+
+  addSpaceBefore (string) {
+    for (let i = 0; i < this.spacing; i++) {
+      string = ' ' + string
+    }
+    return string
+  }
+}
+
+module.exports = WebPrinter

package/ui/index.js

@@ -1,5 +1,7 @@
 const spacing = 1
+const Enquirer = require('enquirer')
 const { Select } = require('enquirer')
+const chalk = require('chalk')
 
 const { spawn } = require('child_process')
 
@@ -7,6 +9,7 @@ const Game = require('./Game')
 const Printer = require('./Printer')
 
 const printer = new Printer(spacing)
+const enquirer = new Enquirer()
 
 /**
  * Welcome to Schachnovelle
@@ -19,6 +22,9 @@ exports.welcomeMessage = () => {
   printer.addSpace('y')
   printer.printLine(printer.addSpaceBefore('      >>Um Gottes Willen! Nicht!<<'))
   printer.addSpace('y')
+  printer.printLine(printer.addSpaceBefore('       Public Service Announcement           '))
+  printer.printLine(printer.addSpaceBefore('      I run best on a white terminal          '))
+  printer.addSpace('y')
 }
 
 // 
@@ -72,7 +78,10 @@ exports.localGame = () => {
       const game = new Game({
         playingAs: choices.color,
         spacing,
-        mode: 'bare'
+        mode: 'bare',
+        enquirer,
+        printer,
+        chalk
       })
           
       printer.clearView()
@@ -91,25 +100,25 @@ exports.init = () => {
   // Don't be shy, say hello to that person!
   this.welcomeMessage()
 
+  this.localGame()
 
-  const what = new Select({
-    name: 'todo',
-    message: 'How do you want to play?',
-    choices: ['local', 'on lichess (beta)']
-  })
+  // const what = new Select({
+  //   name: 'todo',
+  //   message: 'How do you want to play?',
+  //   choices: ['local', 'on lichess (beta)']
+  // })
 
-  what.run()
-    .then((answer) => {
-      printer.addSpace('y')
+  // what.run()
+  //   .then((answer) => {
+  //     printer.addSpace('y')
 
-      if (answer === 'local') {
-        this.localGame()
-      } else {
-        this.spawnServer()
+  //     if (answer === 'local') {
+  //     } else {
+  //       this.spawnServer()
 
-        printer.addSpace('y')
-        printer.printLine(printer.addSpaceBefore('      Log in with Lichess to begin'))
-        printer.addSpace('y')
-      }
-    })
+  //       printer.addSpace('y')
+  //       printer.printLine(printer.addSpaceBefore('      Log in with Lichess to begin'))
+  //       printer.addSpace('y')
+  //     }
+  //   })
 }

package/ui/plainChalk.js

@@ -0,0 +1,19 @@
+const stripChalkMarkup = (value) => {
+  return value.replace(/\{[^}\s]*\s/g, '').replace(/\}/g, '')
+}
+
+const plainChalk = (strings, ...values) => {
+  let output = ''
+  for (let i = 0; i < strings.length; i++) {
+    output += strings[i]
+    if (i < values.length) {
+      output += values[i]
+    }
+  }
+  return stripChalkMarkup(output)
+}
+
+plainChalk.bgKeyword = () => (value) => stripChalkMarkup(value)
+plainChalk.bgBlackBright = (value) => stripChalkMarkup(value)
+
+module.exports = plainChalk

package/ui/web.js

@@ -0,0 +1,53 @@
+const Game = require('./Game')
+const WebPrinter = require('./WebPrinter')
+const createWebPrompt = require('./webPrompt')
+const plainChalk = require('./plainChalk')
+
+const spacing = 1
+
+const welcomeMessage = (printer) => {
+  printer.addSpace('y')
+  printer.printLine(printer.addSpaceBefore('S      .     C      .       V       .       E'))
+  printer.printLine(printer.addSpaceBefore('   C      A     H       O       E       L    '))
+  printer.printLine(printer.addSpaceBefore('.      H     .      N       .       L       .'))
+  printer.addSpace('y')
+  printer.printLine(printer.addSpaceBefore('      >>Um Gottes Willen! Nicht!<<'))
+  printer.addSpace('y')
+  printer.printLine(printer.addSpaceBefore('       Public Service Announcement           '))
+  printer.printLine(printer.addSpaceBefore('      I run best on a white terminal          '))
+  printer.addSpace('y')
+}
+
+const createWebGame = (io, options = {}) => {
+  const prompt = createWebPrompt(io)
+  const printer = new WebPrinter(options.spacing || spacing, io)
+
+  welcomeMessage(printer)
+
+  prompt.prompt([{
+    type: 'select',
+    name: 'color',
+    message: 'Play as',
+    choices: ['white', 'black']
+  }]).then((answer) => {
+    const game = new Game({
+      playingAs: answer.color,
+      spacing: options.spacing || spacing,
+      mode: 'bare',
+      enquirer: prompt,
+      printer,
+      chalk: plainChalk
+    })
+
+    printer.clearView()
+    game.init()
+  }).catch((error) => {
+    if (io && io.write) {
+      io.write(`Error starting game: ${error?.message || error}\n`)
+    }
+  })
+}
+
+module.exports = {
+  createWebGame
+}

package/ui/webPrompt.js

@@ -0,0 +1,59 @@
+const createWebPrompt = (io) => {
+  let pendingResolve = null
+
+  if (io && io.onLine) {
+    io.onLine((line) => {
+      if (pendingResolve) {
+        const resolve = pendingResolve
+        pendingResolve = null
+        resolve(line)
+      }
+    })
+  }
+
+  const ask = (question) => {
+    const choices = question.choices || []
+    io.write(`${question.message}\n`)
+    choices.forEach((choice, index) => {
+      io.write(`  ${index + 1}) ${choice}\n`)
+    })
+    io.write('> ')
+
+    return new Promise((resolve) => {
+      const resolveChoice = (line) => {
+        const trimmed = `${line}`.trim()
+        let selection = choices.find(choice => choice === trimmed)
+        if (!selection) {
+          const index = Number(trimmed)
+          if (index >= 1 && index <= choices.length) {
+            selection = choices[index - 1]
+          }
+        }
+
+        if (!selection) {
+          io.write('Invalid choice, try again.\n')
+          io.write('> ')
+          pendingResolve = resolveChoice
+          return
+        }
+
+        const result = question.result ? question.result(selection) : selection
+        resolve({ [question.name]: result })
+      }
+
+      pendingResolve = resolveChoice
+    })
+  }
+
+  return {
+    prompt: async (questions) => {
+      if (!Array.isArray(questions) || questions.length === 0) {
+        return {}
+      }
+
+      return ask(questions[0])
+    }
+  }
+}
+
+module.exports = createWebPrompt

package/web.js

@@ -0,0 +1,5 @@
+const { createWebGame } = require('./ui/web')
+
+module.exports = {
+  createWebGame
+}