@tabnas/chess
v0.2.0
Published
A Tabnas grammar plugin that parses chess notation: PGN games and the SAN moves inside them.
Maintainers
Readme
@tabnas/chess
A Tabnas grammar plugin that parses chess notation: PGN games and the SAN moves inside them.
The repository hub, with the scope table and the grammar diagram, is
../README.md. This file is the package's own entry point.
Install
npm install @tabnas/parser @tabnas/chess@tabnas/parser is a peer dependency. No other grammar is needed
underneath; this plugin installs on a bare engine.
Use
const { Tabnas } = require('@tabnas/parser')
const { Chess } = require('@tabnas/chess')
const tn = new Tabnas().use(Chess)
const game = tn.parse('[White "Fischer"]\n\n1. e4 e5 2. Nf3 {solid} 1-0')[0]
game.tags.White // => 'Fischer'
game.result // => '1-0'
game.moves[2].san // => 'Nf3'
game.moves[2].comments[0].text // => 'solid'Or, without touching the engine:
const { parse, parseGame, parseSan } = require('@tabnas/chess')
parse('1. e4 1-0\n\n1. d4 0-1').length // => 2
parseGame('1. e4 e5 *').moves.length // => 2
parseSan('O-O-O').castle // => 'queen'make() builds the engine with the plugin installed, which also parses a
source from a reader a window at a time (tn.parseReader), holding a
window of the text rather than all of it.
reference.md has the details.
Documentation
Four-quadrant Diátaxis docs:
- tutorial.md. Learning-oriented: zero to a working parser, step by step.
- guide.md. Task-oriented recipes for real problems.
- reference.md. The exact API surface, options and notation accepted.
- concepts.md. The data model, the grammar, and why both look the way they do.
Build and test
npm install
npm test # builds first, then node --test over dist-test/*.test.js and test/docs.test.jsnpm test runs npm run build first, as its pretest, and the build
embeds ../chess-grammar.jsonic into
src/chess.ts before compiling. Never hand-edit between the
BEGIN/END EMBEDDED markers; edit the grammar and re-run npm run embed.
License
MIT. Copyright (c) Richard Rodger.
