@echecs/pgn 1.0.0 → 2.1.2

package/src/grammar.ne

@@ -5,43 +5,66 @@
 # ----- pgn ----- #
 DATABASE -> GAME:+ {% id %}
 
-GAME -> TAGS __ MOVES __ result __ {%
-    (d) => ({ meta: d[0], moves: d[2], result: d[4] })
+# TAGS contains whitespace at the end
+GAME -> TAGS MOVE_SECTION __ result __ {%
+    (d) => ({ meta: d[0], moves: d[1], result: d[3] })
 %}
 # ----- /pgn ---- #
 
 # ----- tags ----- #
-TAGS -> TAG:+ {% (d) => d[0].reduce((acc, item) => ({ ...acc, ...item }), {}) %}
+TAGS -> (TAG __):+ {% (d) => d[0].map(d0 => d0[0]).reduce((acc, item) => ({ ...acc, ...item }), {}) %}
 
-TAG -> "[" NAME __  VALUE "]" __ {% (d) => ({ [d[1]]: d[3] }) %}
+TAG -> "[" NAME __ VALUE "]" {% (d) => ({ [d[1]]: d[3] }) %}
 
 NAME -> string
 
 VALUE -> dqstring {% id %}
-# ----- /tags ---- #
+# ----- /tags ----- #
 
 
 # ----- moves ----- #
-MOVES -> MOVE:* HALFMOVE:? {%
+MOVE_SECTION ->
+    MOVE (_ MOVE):* (_ HM_WHITE):? {%
+        (d) => {
+            const moves = [d[0]];
+
+            if (d[1].length > 0) {
+                const d1 = d[1];
+
+                moves.push(...d1.map(d => d[1]));
+            }
+
+            if (d[2]) {
+                const d2 = d[2];
+
+                moves.push(d2[1]);
+            }
+
+            return moves;
+        }
+    %}
+    | HM_WHITE {% d => [d[0]] %}
+
+MOVES -> (_ MOVE):* (_ HM_WHITE):? {%
     (d) => {
         const moves = [];
-        const assign = (number, ...move) => {
-            moves[number - 1] = move;
-        };
 
-        d[0].map(dd0 => assign(...dd0));
+        if (d[0]) {
+            d[0].map(d0 => d0[1]).map(d01 => moves.push(d01));
+        }
 
         if (d[1]) {
-            assign(...d[1]);
+            moves.push(d[1][1]);
         }
 
         return moves;
     }
 %}
 
-HALFMOVE -> NUMBER _ SAN (_ VARIATION):? _ {%
+# Half Move White #
+HM_WHITE -> NUMBER _ SAN (_ VARIANT):* {%
     (d) => {
-        const move = [d[0], {...d[2], ...(d[3] && { variation: d[3][1] }), }];
+        const move = [d[0], {...d[2], ...(d[3].length > 0 && { variants: d[3].map(d3 => d3[1]) }), }];
 
         if (move[1].castling) {
             move[1].to = move[1].castling === 'K' ? 'g1' : 'c1';
@@ -52,128 +75,156 @@ HALFMOVE -> NUMBER _ SAN (_ VARIATION):? _ {%
     }
 %}
 
-MOVE -> NUMBER _ SAN __ SAN (_ VARIATION):? _ {%
+HM_BLACK -> _ NUMBER continuation _ SAN (_ VARIANT):* {%
     (d) => {
-        const move = [d[0], d[2], d[4]];
-
-        if (move[1].castling) {
-            move[1].to = move[1].castling === 'K' ? 'g1' : 'c1';
-            move[1].castling = true;
-        }
+        const move = [d[1], undefined, {...d[4], ...(d[5].length > 0 && { variants: d[5].map(d5 => d5[1]) }) }];
 
         if (move[2].castling) {
             move[2].to = move[2].castling === 'K' ? 'g8' : 'c8';
             move[2].castling = true;
         }
 
-        if (d[5]) {
-            const variant = d[5][1];
-            const isWhite = variant[0][0] !== undefined;
-
-            move[isWhite ? 1 : 2].variation = d[5][1];
-        }
-
         return move;
     }
 %}
 
-VARIATION ->
-    "(" MOVES ")" {%
-        (d) => [...d[1].values()].filter(Boolean)
-    %}
-    | "(" MOVES_BLACK ")" {%
-        (d) => [...d[1].values()].filter(Boolean)
-    %}
+MOVE ->
+    NUMBER _ SAN __ SAN (_ VARIANT):* {%
+        (d) => {
+            const move = [d[0], d[2], d[4]];
 
-MOVES_BLACK -> HALFMOVE_BLACK MOVES:? {%
-    (d) => {
-        const moves = d[1] || [];
+            if (move[1].castling) {
+                move[1].to = move[1].castling === 'K' ? 'g1' : 'c1';
+                move[1].castling = true;
+            }
 
-        const assign = (number, ...move) => {
-            moves[number - 1] = move;
-        };
+            if (move[2].castling) {
+                move[2].to = move[2].castling === 'K' ? 'g8' : 'c8';
+                move[2].castling = true;
+            }
 
-        if (d[0]) {
-            assign(...d[0]);
-        }
+            if (d[5]) {
+                const variants = d[5].map(d5 => d5[1]);
 
-        return moves;
-    }
-%}
+                const white = variants.filter(variant => variant[0][1]);
+                const black = variants.filter(variant => !variant[0][1]);
 
-HALFMOVE_BLACK -> NUMBER continuation _ SAN (_ VARIATION):? _ {%
-    (d) => {
-        const move = [
-            d[0],
-            undefined,
-            {...d[3], ...(d[4] && { variation: d[4][1] }), }
-        ];
+                if (white.length > 0) {
+                    move[1].variants = white;
+                }
 
-        if (move[2].castling) {
-            move[2].to = move[2].castling === 'K' ? 'g8' : 'c8';
-            move[2].castling = true;
+                if (black.length > 0) {
+                    move[2].variants = black;
+                }
+            }
+
+            return move;
         }
+    %}
+    | HM_WHITE __ HM_BLACK {%
+        d => [d[0][0], d[0][1], d[2][2]]
+    %}
 
-        return move;
-    }
-%}
+NUMBER -> unsigned_int ".":? {% (d) => d[0] %}
 
-NUMBER -> unsigned_int ".":* {% (d) => d[0] %}
+VARIANT ->
+    "(" MOVES _ ")" {%
+        (d) => d[1]
+    %}
+    | "(" HM_BLACK MOVES _ ")" {%
+        (d) => [d[1], ...d[2]]
+    %}
+
+# ----- /moves ----- #
+
+# ----- san ----- #
 
 SAN ->
-    piece:? DISAMBIGUATION:? capture:? file rank promotion:? (_ annotation):* (_ COMMENT):? {%
+    piece:? DISAMBIGUATION:? capture:? file rank PROMOTION:? (_ SUFFIX):? (_ COMMENT):* {%
+        (d) => {
+            const comments = d[7].map(d7 => d7[1]).filter(Boolean);
+
+            return  ({
+               ...(d[6] && d[6][1]),
+               ...(comments.length > 0 && { comment: comments.reduce((acc, item) => `${acc} ${item}`, '') }),
+               ...(d[2] && { capture: true }),
+               ...(d[1] && { from: d[1][0] }),
+               piece: d[0] ? d[0][0] : 'P',
+               ...(d[5] && { promotion: d[5] }),
+               to: `${d[3]}${d[4]}`,
+            });
+        }
+    %}
+    | castling (_ SUFFIX):* (_ COMMENT):* {%
+        (d) => {
+            const comments = d[2].map(d2 => d2[1]).filter(Boolean);
+
+            return ({
+               ...(d[1]),
+               ...(comments.length > 0 && { comment: comments.reduce((acc, item) => `${acc} ${item}`, '') }),
+               castling: d[0],
+               piece: 'K'
+            })
+        }
+    %}
+
+DISAMBIGUATION ->
+    file {% id %}
+    | rank {% id %}
+
+PROMOTION -> "=" [QBNR] {% (d) => d[1] %}
+
+SUFFIX ->
+    (check | checkmate) annotation:? (_ NAG):* {%
+        (d) => ({
+            ...(d[0] && { [d[0]]: true }),
+            ...((d[1] || d[2].length > 0) && { annotations: [...(d[1] ? [d[1]] : []), ...d[2].map(d2 => d2[1])] }),
+        })
+    %}
+    | (check | checkmate):? annotation (_ NAG):* {%
         (d) => ({
-            ...(d[6].length > 0 && { annotations: d[6].map(([_, a]) => a) }),
-            ...(d[7] && { comment: d[7][1] }),
-            ...(d[1] && { from: d[1][0] }),
-            piece: d[0] ? d[0][0] : 'P',
-            ...(d[5] && { promotion: d[5] }),
-            to: `${d[3]}${d[4]}`,
+            ...(d[0] && { [d[0]]: true }),
+            ...((d[1] || d[2].length > 0) && { annotations: [...(d[1] ? [d[1]] : []), ...d[2].map(d2 => d2[1])] }),
         })
     %}
-    | castling (_ annotation):* (_ COMMENT):? {%
+    | (check | checkmate):? annotation:? (_ NAG):+ {%
         (d) => ({
-            ...(d[1].length > 0 && { annotations: d[1].map(([_, a]) => a) }),
-            ...(d[2] && { comment: d[2][1] }),
-            castling: d[0],
-            piece: 'K'
+            ...(d[0] && { [d[0]]: true }),
+            ...((d[1] || d[2].length > 0) && { annotations: [...(d[1] ? [d[1]] : []), ...d[2].map(d2 => d2[1])] }),
         })
     %}
 
-DISAMBIGUATION ->
-    file {% id %}
-    | rank {% id %}
+# Numeric Annotation Glyph
+NAG -> "$" ("25" [0-5] | "2" [0-4] [0-9] | "1" [0-9] [0-9] | [1-9] [0-9] | [0-9]) {%
+    (d) => d[1]
+%}
 
-COMMENT -> bstring
+COMMENT -> bstring | ";" [^\n]:*
 
-# ----- /moves ---- #
+# ----- /san ----- #
 
 # types
 annotation ->
     "!!" {% id %}
     | "!" {% id %}
     | "!?" {% id %}
-    | "#" {% () => 'checkmate' %}
-    | "$1" {% () => '!' %}
-    | "$2" {% () => '?' %}
-    | "$3" {% () => '!!' %}
-    | "$4" {% () => '!?' %}
-    | "$5" {% () => '?!' %}
-    | "$6" {% () => '??' %}
-    | "+" {% () => 'check' %}
+    | "?!" {% id %}
+    | "?" {% id %}
+    | "??" {% id %}
     | "+-" {% id %}
     | "-+" {% id %}
     | "=" {% id %}
     | "?!" {% id %}
     | "?" {% id %}
     | "??" {% id %}
-    | "N" {% id %}
     | "±" {% id %}
     | "∓" {% id %}
     | "∞" {% id %}
     | "⨀" {% id %}
     | "⩱" {% id %}
     | "⩲" {% id %}
+check -> "+" {% () => 'check' %}
+checkmate -> "#" {% () => 'checkmate' %}
 bstring -> "{" [^}]:* "}" {% (d) => d[1].join('') %}
 capture -> "x"
 castling ->
@@ -182,7 +233,6 @@ castling ->
 continuation -> "..."
 file -> [a-h]
 piece -> [KQBNR]
-promotion -> "=" [QBNR] {% (d) => d[1] %}
 rank -> [1-8]
 result ->
     "1-0" {% () => 1 %}

package/src/index.ts

@@ -0,0 +1,59 @@
+import { Grammar, Parser } from 'nearley';
+
+import grammar from './grammar';
+
+type File = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h';
+type Piece = 'B' | 'K' | 'N' | 'P' | 'Q' | 'R';
+type Rank = '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8';
+type Result = '1-0' | '0-1' | '1/2-1/2' | '?';
+
+type Square = `${File}${Rank}`;
+
+type HalfMove = [number, undefined, Move];
+type VariantMove = Move | HalfMove;
+type VariantMoves = VariantMove[];
+
+type Move = {
+  annotations?: string[];
+  capture?: boolean;
+  castling?: boolean;
+  check?: boolean;
+  checkmate?: boolean;
+  comment?: string;
+  from?: File | Rank;
+  piece: Piece;
+  promotion?: Piece;
+  to: Square;
+  variants?: VariantMoves[];
+};
+
+type Meta = {
+  Result: Result;
+  [key: string]: string;
+};
+
+type Moves = [number, Move] | [number, Move, Move];
+
+type PGN = {
+  meta: Meta;
+  moves: Moves;
+  result: Result;
+};
+
+function tokenize(input: string): PGN[] {
+  const parser = new Parser(Grammar.fromCompiled(grammar));
+
+  parser.feed(input);
+
+  if (parser.results.length > 1) {
+    throw new Error(`@echecs/parser: Ambiguous syntax. Found ${parser.results.length} results`);
+  }
+
+  return parser.results[0] as PGN[];
+}
+
+export default function parse(input: string): PGN[] {
+  const games = input.replace(/[\r\uFEFF]/g, '');
+
+  return tokenize(games);
+}

package/tsconfig.eslint.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "outDir": "dist/",
+    "removeComments": true,
+    "resolveJsonModule": true,
+    "strict": true,
+    "target": "ESNext"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "outDir": "dist/",
+    "removeComments": true,
+    "resolveJsonModule": true,
+    "strict": true,
+    "target": "ESNext"
+  },
+  "files": ["src/index.ts"]
+}

package/dist/cjs/pgn.js

@@ -1,25 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
-
-var nearley = _interopDefault(require('nearley'));
-var grammar = _interopDefault(require('./grammar.js'));
-
-const {
-  Grammar,
-  Parser
-} = nearley;
-
-
-
-var src = function parse(string) {
-  const parser = new Parser(Grammar.fromCompiled(grammar));
-  string = string.replace(/\r/g, '');
-  parser.feed(string);
-  return parser.results[0];
-};
-
-exports.default = src;
-//# sourceMappingURL=pgn.js.map

package/dist/cjs/pgn.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"pgn.js","sources":["../../src/index.js"],"sourcesContent":["const { Grammar, Parser } = require('nearley');\n\nconst grammar = require('./grammar');\n\nmodule.exports = function parse(string) {\n  const parser = new Parser(Grammar.fromCompiled(grammar));\n\n  string = string.replace(/\\r/g, '');\n\n  parser.feed(string);\n\n  return parser.results[0];\n};\n"],"names":["Grammar","Parser","require","module","parse","string","parser","fromCompiled","grammar","replace","feed","results"],"mappings":";;;;;;;;;AAAA,MAAM;AAAEA,EAAAA,OAAF;AAAWC,EAAAA;AAAX,IAAsBC,OAA5B;;;;AAIAC,OAAA,GAAiB,SAASC,KAAT,CAAeC,MAAf,EAAuB;AACtC,QAAMC,MAAM,GAAG,IAAIL,MAAJ,CAAWD,OAAO,CAACO,YAAR,CAAqBC,OAArB,CAAX,CAAf;AAEAH,EAAAA,MAAM,GAAGA,MAAM,CAACI,OAAP,CAAe,KAAf,EAAsB,EAAtB,CAAT;AAEAH,EAAAA,MAAM,CAACI,IAAP,CAAYL,MAAZ;AAEA,SAAOC,MAAM,CAACK,OAAP,CAAe,CAAf,CAAP;AACD,CARD;;;;"}

package/dist/es/pgn.js

@@ -1,19 +0,0 @@
-import nearley from 'nearley';
-import grammar from './grammar.js';
-
-const {
-  Grammar,
-  Parser
-} = nearley;
-
-
-
-var src = function parse(string) {
-  const parser = new Parser(Grammar.fromCompiled(grammar));
-  string = string.replace(/\r/g, '');
-  parser.feed(string);
-  return parser.results[0];
-};
-
-export default src;
-//# sourceMappingURL=pgn.js.map

package/dist/es/pgn.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"pgn.js","sources":["../../src/index.js"],"sourcesContent":["const { Grammar, Parser } = require('nearley');\n\nconst grammar = require('./grammar');\n\nmodule.exports = function parse(string) {\n  const parser = new Parser(Grammar.fromCompiled(grammar));\n\n  string = string.replace(/\\r/g, '');\n\n  parser.feed(string);\n\n  return parser.results[0];\n};\n"],"names":["Grammar","Parser","require","module","parse","string","parser","fromCompiled","grammar","replace","feed","results"],"mappings":";;;AAAA,MAAM;AAAEA,EAAAA,OAAF;AAAWC,EAAAA;AAAX,IAAsBC,OAA5B;;;;AAIAC,OAAA,GAAiB,SAASC,KAAT,CAAeC,MAAf,EAAuB;AACtC,QAAMC,MAAM,GAAG,IAAIL,MAAJ,CAAWD,OAAO,CAACO,YAAR,CAAqBC,OAArB,CAAX,CAAf;AAEAH,EAAAA,MAAM,GAAGA,MAAM,CAACI,OAAP,CAAe,KAAf,EAAsB,EAAtB,CAAT;AAEAH,EAAAA,MAAM,CAACI,IAAP,CAAYL,MAAZ;AAEA,SAAOC,MAAM,CAACK,OAAP,CAAe,CAAf,CAAP;AACD,CARD;;;;"}

package/index.js

@@ -1 +0,0 @@
-module.exports = require('./dist/cjs/pgn.js');

package/index.module.js

@@ -1 +0,0 @@
-module.exports = require('./dist/es/pgn.js');

package/src/index.js

@@ -1,13 +0,0 @@
-const { Grammar, Parser } = require('nearley');
-
-const grammar = require('./grammar');
-
-module.exports = function parse(string) {
-  const parser = new Parser(Grammar.fromCompiled(grammar));
-
-  string = string.replace(/\r/g, '');
-
-  parser.feed(string);
-
-  return parser.results[0];
-};