quoridor

quoridor.js

Installation

npm install quoridor

API

createGameFromMoves: (moves: Move[]) => Game

Generates a game from an array of moves. Does not validate the moves.

import { createGameFromMoves, getAsciiRepresentation } from 'quoridor';

const game = createGameFromMoves(['e2', 'e8', 'd7v']);

console.log(getAsciiRepresentation(game));

┌───╫───╫───╫───╫───╫───╫───╫───╫───╫───╫───┐
│   ║   ║   ║   ║   ║   ║   ║   ║   ║   ║   │
│   ┌───┬───┬───┬───┬───┬───┬───┬───┬───┐   │
│ 9 │   │   │   │   │   │   │   │   │   │   │
│   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
│ 8 │   │   │   │   │   │   │   │   │   │   │
│   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
│ 7 │   │   │   │   ║ 2 │   │   │   │   │   │
│   ├───┼───┼───┼───╫───┼───┼───┼───┼───┤   │
│ 6 │   │   │   │   ║   │   │   │   │   │   │
│   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
│ 5 │   │   │   │   │   │   │   │   │   │   │
│   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
│ 4 │   │   │   │   │   │   │   │   │   │   │
│   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
│ 3 │   │   │   │   │ 1 │   │   │   │   │   │
│   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
│ 2 │   │   │   │   │   │   │   │   │   │   │
│   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
│ 1 │   │   │   │   │   │   │   │   │   │   │
│   └───┴───┴───┴───┴───┴───┴───┴───┴───┘   │
│   ║ A ║ B ║ C ║ D ║ E ║ F ║ G ║ H ║ I     │
└───╫───╫───╫───╫───╫───╫───╫───╫───╫───────┘

Publishing a new version

Check that linting, formatting, build and tests pass

npm run lint
npm run format
npm run build
npm test

Bump version

npm version [major | minor | patch]

Publish to NPM

npm publish