kokopu-react 1.11.0 → 2.0.0

package/test/graphic_test_app/.eslintrc.yml

@@ -0,0 +1,5 @@
+env:
+  node: false
+  mocha: false
+  browser: true
+  es2021: true

package/test/graphic_test_app/03_error_box_graphic/base.tsx

@@ -0,0 +1,46 @@
+/* -------------------------------------------------------------------------- *
+ *                                                                            *
+ *    This file is part of Kokopu-React, a JavaScript chess library.          *
+ *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *                                                                            *
+ *    This program is free software: you can redistribute it and/or           *
+ *    modify it under the terms of the GNU Lesser General Public License      *
+ *    as published by the Free Software Foundation, either version 3 of       *
+ *    the License, or (at your option) any later version.                     *
+ *                                                                            *
+ *    This program is distributed in the hope that it will be useful,         *
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of          *
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
+ *    GNU Lesser General Public License for more details.                     *
+ *                                                                            *
+ *    You should have received a copy of the GNU Lesser General               *
+ *    Public License along with this program. If not, see                     *
+ *    <http://www.gnu.org/licenses/>.                                         *
+ *                                                                            *
+ * -------------------------------------------------------------------------- */
+
+
+import * as React from 'react';
+import { testApp } from '../common/test_app';
+import { ErrorBox } from '../../../dist/lib/index';
+
+testApp([ /* eslint-disable react/jsx-key */
+
+	<ErrorBox title="I'm the title" message="I'm the message" />,
+	<ErrorBox title="The title" message="Keep both the beginning and the end" text="| Error: x <- is here" errorIndex={9} lineNumber={1} />,
+
+	<ErrorBox title="No error index" message="Nothing below" text="You will not see this..." />,
+	<ErrorBox title="No error text" message="Nothing below" errorIndex={1} />,
+	<ErrorBox title="Negative error index" message="Nothing below" text="You will not see this..." errorIndex={-1} />,
+	<ErrorBox title="Too large error index" message="Nothing below" text="You will not see this..." errorIndex={100} />,
+	<ErrorBox title="Error index not an integer" message="Nothing below" text="You will not see this..." errorIndex={2.3} />,
+
+	<ErrorBox title="Cut the end of the text" message="and keep all the beginning" text="| x <- the error is there and the rest of the line is cut because too long"
+		errorIndex={2} />,
+	<ErrorBox title="Cut the beginning of the text" message="and keep all the end" text="The error is there -> x 234567890 234567890 234567890 234567890"
+		errorIndex={22} lineNumber={0} />,
+	<ErrorBox title="Cut on line breaks" message="both at the beginning and at the end" text={'This is the first line\n| x |\nThis is the third line'}
+		errorIndex={25} lineNumber={2} />,
+	<ErrorBox title="Single character text" message="The text is 1-character long" text="x" errorIndex={0} lineNumber={1.1} />,
+
+]); /* eslint-enable react/jsx-key */

package/{scripts/clean-graphic-output.js → test/graphic_test_app/03_error_box_graphic/localization.tsx}

@@ -1,4 +1,4 @@
-/******************************************************************************
+/* -------------------------------------------------------------------------- *
  *                                                                            *
  *    This file is part of Kokopu-React, a JavaScript chess library.          *
  *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
@@ -17,13 +17,16 @@
  *    Public License along with this program. If not, see                     *
  *    <http://www.gnu.org/licenses/>.                                         *
  *                                                                            *
- ******************************************************************************/
+ * -------------------------------------------------------------------------- */
 
 
-const fs = require('fs');
+import * as React from 'react';
+import { testApp } from '../common/test_app';
+import { ErrorBox, i18n } from '../../../dist/lib/index';
 
-const rootDir = __dirname + '/..';
-const outputDir = rootDir + '/build/graphic_output';
+// Checking localization...
+i18n.LINE = 'ligne {0} (+ invalid placeholder {1})';
 
-// Erase the directory in which the screenshots are generated.
-fs.rmSync(outputDir, { force: true, recursive: true });
+testApp([ /* eslint-disable react/jsx-key */
+	<ErrorBox title="The title" message="The message" text="| x <- error is here" errorIndex={2} lineNumber={42} />,
+]); /* eslint-enable react/jsx-key */

package/{graphic_test_src/01_marker_icons.js → test/graphic_test_app/04_marker_icons_graphic/base.tsx}

@@ -1,4 +1,4 @@
-/******************************************************************************
+/* -------------------------------------------------------------------------- *
  *                                                                            *
  *    This file is part of Kokopu-React, a JavaScript chess library.          *
  *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
@@ -17,23 +17,31 @@
  *    Public License along with this program. If not, see                     *
  *    <http://www.gnu.org/licenses/>.                                         *
  *                                                                            *
- ******************************************************************************/
+ * -------------------------------------------------------------------------- */
 
 
-import React from 'react';
-import testApp from './common/test_app';
-import { SquareMarkerIcon, TextMarkerIcon, ArrowMarkerIcon } from '../src/index';
+import * as React from 'react';
+import { testApp } from '../common/test_app';
+import { SquareMarkerIcon, TextMarkerIcon, ArrowMarkerIcon } from '../../../dist/lib/index';
 
 testApp([ /* eslint-disable react/jsx-key */
+
 	<SquareMarkerIcon size={40} />,
 	<SquareMarkerIcon size={45} color="green" />,
 	<div style={{ color: 'purple' }}><SquareMarkerIcon size={31} /></div>,
+	<SquareMarkerIcon size={ /* eslint-disable @typescript-eslint/no-explicit-any */ 'not-a-number' as any /* eslint-enable @typescript-eslint/no-explicit-any */ } />,
+
 	<TextMarkerIcon size={41} symbol="A" />,
 	<TextMarkerIcon size={29} symbol="b" color="#0ff" />,
 	<div style={{ color: 'red' }}><TextMarkerIcon size={53} symbol="5" /></div>,
+	<TextMarkerIcon size={47} symbol="dot" color="#00f" />,
+	<div style={{ color: 'pink' }}><TextMarkerIcon size={48} symbol="circle" /></div>,
+	<TextMarkerIcon size={ /* eslint-disable @typescript-eslint/no-explicit-any */ 'not-a-number' as any /* eslint-enable @typescript-eslint/no-explicit-any */ } symbol="A" />,
+	<TextMarkerIcon size={40} symbol={ /* eslint-disable @typescript-eslint/no-explicit-any */ 'not-a-symbol' as any /* eslint-enable @typescript-eslint/no-explicit-any */ } />,
+
 	<ArrowMarkerIcon size={40} />,
 	<ArrowMarkerIcon size={24} color="#888" />,
 	<div style={{ color: '#f70' }}><ArrowMarkerIcon size={48} /></div>,
-	<TextMarkerIcon size={47} symbol="dot" color="#00f" />,
-	<div style={{ color: 'pink' }}><TextMarkerIcon size={48} symbol="circle" /></div>,
+	<ArrowMarkerIcon size={ /* eslint-disable @typescript-eslint/no-explicit-any */ 'not-a-number' as any /* eslint-enable @typescript-eslint/no-explicit-any */ } />,
+
 ]); /* eslint-enable react/jsx-key */

package/{graphic_test_src/04_chessboard_annotations.js → test/graphic_test_app/05_chessboard_graphic/annotations.tsx}

@@ -1,4 +1,4 @@
-/******************************************************************************
+/* -------------------------------------------------------------------------- *
  *                                                                            *
  *    This file is part of Kokopu-React, a JavaScript chess library.          *
  *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
@@ -17,24 +17,33 @@
  *    Public License along with this program. If not, see                     *
  *    <http://www.gnu.org/licenses/>.                                         *
  *                                                                            *
- ******************************************************************************/
+ * -------------------------------------------------------------------------- */
 
 
-import React from 'react';
-import testApp from './common/test_app';
-import { Chessboard } from '../src/index';
+import * as React from 'react';
+import { testApp } from '../common/test_app';
+import { Chessboard, AnnotationColor, AnnotationSymbol } from '../../../dist/lib/index';
 
-let squareMarkers1 = 'Ba1,Ba2,Gb1,Gb2,Rc1,Rc2,Yd1,Yd2';
-let arrowMarkers1 = 'Ba8b6,Gb8c6,Re8f6,Yf8g6';
-let textMarkers1 = 'B(circle)e1,B(plus)e2,GAf1,Gaf2,RZg1,Rzg2,Y2h1,Y8h2';
+const squareMarkers1 = 'Ba1,Ba2,Gb1,Gb2,Rc1,Rc2,Yd1,Yd2';
+const arrowMarkers1 = 'Ba8b6,Gb8c6,Re8f6,Yf8g6';
+const textMarkers1 = 'B(circle)e1,B(plus)e2,GAf1,Gaf2,RZg1,Rzg2,Y2h1,Y8h2';
 
-let squareMarkers2 = { e4: 'g', g5: 'r', g1: 'y', h4: 'b' };
-let arrowMarkers2 = { c3a2: 'b', c4a4: 'g', c5a6: 'r', c6a8: 'y', d6c8: 'b', e6e8: 'g', f6g8: 'r' };
-let textMarkers2 = { g3: { symbol: 'H', color: 'r' }, g5: { symbol: 'M', color: 'g' }, h4: { symbol: 'times', color: 'y' } };
+const B: AnnotationColor = 'b';
+const G: AnnotationColor = 'g';
+const R: AnnotationColor = 'r';
+const Y: AnnotationColor = 'y';
 
-let squareMarkers3 = { b5: 'r', e4: 'g', h5: 'y', e2: 'b' };
-let arrowMarkers3 = { d1h5: 'g', a5f4: 'r', c7c3: 'y', g7g7: 'g' };
-let textMarkers3 = 'G5c6,R(plus)a1,G(times)b1,B(dot)a2,Y(circle)b2';
+const SYMBOL_H: AnnotationSymbol = 'H';
+const SYMBOL_M: AnnotationSymbol = 'M';
+const SYMBOL_TIMES: AnnotationSymbol = 'times';
+
+const squareMarkers2 = { e4: G, g5: R, g1: Y, h4: B };
+const arrowMarkers2 = { c3a2: B, c4a4: G, c5a6: R, c6a8: Y, d6c8: B, e6e8: G, f6g8: R };
+const textMarkers2 = { g3: { symbol: SYMBOL_H, color: R }, g5: { symbol: SYMBOL_M, color: G }, h4: { symbol: SYMBOL_TIMES, color: Y } };
+
+const squareMarkers3 = { b5: R, e4: G, h5: Y, e2: B };
+const arrowMarkers3 = { d1h5: G, a5f4: R, c7c3: Y, g7g7: G };
+const textMarkers3 = 'G5c6,R(plus)a1,G(times)b1,B(dot)a2,Y(circle)b2';
 
 testApp([ /* eslint-disable react/jsx-key */
 	<Chessboard squareMarkers={squareMarkers1} arrowMarkers={arrowMarkers1} textMarkers={textMarkers1} flipped={false} coordinateVisible={true} />,

package/{graphic_test_src/02_chessboard_simple.js → test/graphic_test_app/05_chessboard_graphic/base.tsx}

@@ -1,4 +1,4 @@
-/******************************************************************************
+/* -------------------------------------------------------------------------- *
  *                                                                            *
  *    This file is part of Kokopu-React, a JavaScript chess library.          *
  *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
@@ -17,13 +17,13 @@
  *    Public License along with this program. If not, see                     *
  *    <http://www.gnu.org/licenses/>.                                         *
  *                                                                            *
- ******************************************************************************/
+ * -------------------------------------------------------------------------- */
 
 
-import React from 'react';
+import * as React from 'react';
 import { Position } from 'kokopu';
-import testApp from './common/test_app';
-import { Chessboard } from '../src/index';
+import { testApp } from '../common/test_app';
+import { Chessboard } from '../../../dist/lib/index';
 
 testApp([ /* eslint-disable react/jsx-key */
 	<Chessboard />,
@@ -31,5 +31,5 @@ testApp([ /* eslint-disable react/jsx-key */
 	<Chessboard position="something invalid" />,
 	<Chessboard position="r1bqkbnr/pppp1ppp/2n5/1B2p3/4P3/5N2/PPPP1PPP/RNBQK2R b KQkq - 3 3" />,
 	<Chessboard position={new Position('8/8/1r6/8/5k1K/8/8/8 b - - 0 1')} />,
-	<Chessboard position={42} />,
+	<Chessboard position={ /* eslint-disable @typescript-eslint/no-explicit-any */ 42 as any /* eslint-enable @typescript-eslint/no-explicit-any */ } />,
 ]); /* eslint-enable react/jsx-key */

package/test/graphic_test_app/05_chessboard_graphic/chess_variants.tsx

@@ -0,0 +1,35 @@
+/* -------------------------------------------------------------------------- *
+ *                                                                            *
+ *    This file is part of Kokopu-React, a JavaScript chess library.          *
+ *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *                                                                            *
+ *    This program is free software: you can redistribute it and/or           *
+ *    modify it under the terms of the GNU Lesser General Public License      *
+ *    as published by the Free Software Foundation, either version 3 of       *
+ *    the License, or (at your option) any later version.                     *
+ *                                                                            *
+ *    This program is distributed in the hope that it will be useful,         *
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of          *
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
+ *    GNU Lesser General Public License for more details.                     *
+ *                                                                            *
+ *    You should have received a copy of the GNU Lesser General               *
+ *    Public License along with this program. If not, see                     *
+ *    <http://www.gnu.org/licenses/>.                                         *
+ *                                                                            *
+ * -------------------------------------------------------------------------- */
+
+
+import * as React from 'react';
+import { testApp } from '../common/test_app';
+import { Chessboard } from '../../../dist/lib/index';
+
+testApp([ /* eslint-disable react/jsx-key */
+	<Chessboard position="chess960:nqbrnkrb/pppppppp/8/8/8/8/PPPPPPPP/NQBRNKRB w KQkq - 0 1" />,
+	<Chessboard position="chess960:nqbrnkrb/pppppppp/8/8/8/8/PPPPPPPP/NQBRNKRB w KQkq - 0 1" move="O-O" />,
+	<Chessboard position="chess960" />,
+	<Chessboard position="horde" />,
+	<Chessboard position="start" />,
+	<Chessboard position="whatever" />,
+	<Chessboard position="whatever:rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1" />,
+]); /* eslint-enable react/jsx-key */

package/{graphic_test_src/03_chessboard_flipped.js → test/graphic_test_app/05_chessboard_graphic/flipped.tsx}

@@ -1,4 +1,4 @@
-/******************************************************************************
+/* -------------------------------------------------------------------------- *
  *                                                                            *
  *    This file is part of Kokopu-React, a JavaScript chess library.          *
  *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
@@ -17,13 +17,13 @@
  *    Public License along with this program. If not, see                     *
  *    <http://www.gnu.org/licenses/>.                                         *
  *                                                                            *
- ******************************************************************************/
+ * -------------------------------------------------------------------------- */
 
 
-import React from 'react';
+import * as React from 'react';
 import { Position } from 'kokopu';
-import testApp from './common/test_app';
-import { Chessboard } from '../src/index';
+import { testApp } from '../common/test_app';
+import { Chessboard } from '../../../dist/lib/index';
 
 testApp([ /* eslint-disable react/jsx-key */
 	<Chessboard flipped={true} />,

package/{graphic_test_src/05_chessboard_move.js → test/graphic_test_app/05_chessboard_graphic/move.tsx}

@@ -1,4 +1,4 @@
-/******************************************************************************
+/* -------------------------------------------------------------------------- *
  *                                                                            *
  *    This file is part of Kokopu-React, a JavaScript chess library.          *
  *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
@@ -17,16 +17,16 @@
  *    Public License along with this program. If not, see                     *
  *    <http://www.gnu.org/licenses/>.                                         *
  *                                                                            *
- ******************************************************************************/
+ * -------------------------------------------------------------------------- */
 
 
-import React from 'react';
+import * as React from 'react';
 import { Position } from 'kokopu';
-import testApp from './common/test_app';
-import { Chessboard } from '../src/index';
+import { testApp } from '../common/test_app';
+import { Chessboard } from '../../../dist/lib/index';
 
-let pos = new Position('r1bqkbnr/1ppp1ppp/p1n5/1B2p3/4P3/5N2/PPPP1PPP/RNBQK2R w KQkq - 0 4');
-let move = pos.notation('Bxc6');
+const pos = new Position('r1bqkbnr/1ppp1ppp/p1n5/1B2p3/4P3/5N2/PPPP1PPP/RNBQK2R w KQkq - 0 4');
+const move = pos.notation('Bxc6');
 
 testApp([ /* eslint-disable react/jsx-key */
 	<Chessboard move="e4" animated={false} />,
@@ -37,5 +37,6 @@ testApp([ /* eslint-disable react/jsx-key */
 	<Chessboard position="r3k2r/pppppppp/8/8/8/8/PPPPPPPP/R3K2R b KQkq - 0 1" move="O-O-O" animated={false} moveArrowColor="r" />,
 	<Chessboard position="rnbqkbnr/ppp1p1pp/8/3pPp2/8/8/PPPP1PPP/RNBQKBNR w KQkq f6 0 3" move="exf6" animated={false} moveArrowColor="y" />,
 	<Chessboard position="8/8/8/1K6/8/4k3/1p6/8 b - - 0 1" move="b1=R+" animated={false} moveArrowColor="b" />,
-	<Chessboard move={42} animated={false} />,
+	<Chessboard move={ /* eslint-disable @typescript-eslint/no-explicit-any */ 42 as any /* eslint-enable @typescript-eslint/no-explicit-any */ } animated={false} />,
+	<Chessboard move="e4" animated={false} moveArrowColor={ /* eslint-disable @typescript-eslint/no-explicit-any */ 'z' as any /* eslint-enable @typescript-eslint/no-explicit-any */ } />,
 ]); /* eslint-enable react/jsx-key */

package/{graphic_test_src/07_chessboard_theme.js → test/graphic_test_app/05_chessboard_graphic/theme.tsx}

@@ -1,4 +1,4 @@
-/******************************************************************************
+/* -------------------------------------------------------------------------- *
  *                                                                            *
  *    This file is part of Kokopu-React, a JavaScript chess library.          *
  *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
@@ -17,21 +17,21 @@
  *    Public License along with this program. If not, see                     *
  *    <http://www.gnu.org/licenses/>.                                         *
  *                                                                            *
- ******************************************************************************/
+ * -------------------------------------------------------------------------- */
 
 
-import React from 'react';
-import testApp from './common/test_app';
-import { Chessboard } from '../src/index';
+import * as React from 'react';
+import { testApp } from '../common/test_app';
+import { Chessboard } from '../../../dist/lib/index';
 
-let pos1 = '2qb1rk1/3n1p1p/2p3p1/2Pp4/p2P1BQ1/8/P1N2PPP/R5K1 b - - 0 1';
-let mv1 = 'Ba5';
+const pos1 = '2qb1rk1/3n1p1p/2p3p1/2Pp4/p2P1BQ1/8/P1N2PPP/R5K1 b - - 0 1';
+const mv1 = 'Ba5';
 
-let pos2 = 'start';
-let mv2 = 'e4';
+const pos2 = 'start';
+const mv2 = 'e4';
 
-let sm = 'Ba8,Ba7,Gb8,Gb7,Rc8,Rc7,Yd8,Yd7';
-let am = 'Ba1a3,Gb1b3,Rc1c3,Yd1d3';
+const sm = 'Ba8,Ba7,Gb8,Gb7,Rc8,Rc7,Yd8,Yd7';
+const am = 'Ba1a3,Gb1b3,Rc1c3,Yd1d3';
 
 testApp([ /* eslint-disable react/jsx-key */
 	<Chessboard position={pos1} move={mv1} squareMarkers={sm} arrowMarkers={am} animated={false} />,
@@ -43,4 +43,7 @@ testApp([ /* eslint-disable react/jsx-key */
 	<Chessboard position={pos1} move={mv1} squareMarkers={sm} arrowMarkers={am} colorset="emerald" pieceset="skulls" animated={false} />,
 	<Chessboard position={pos2} move={mv2} squareMarkers={sm} arrowMarkers={am} squareSize={91} flipped={true} colorset="gray" pieceset="spatial" animated={false} />,
 	<Chessboard position={pos1} move={mv1} squareMarkers={sm} arrowMarkers={am} squareSize={17} colorset="dusk" animated={false} />,
+	<Chessboard squareSize={ /* eslint-disable @typescript-eslint/no-explicit-any */ '24' as any /* eslint-enable @typescript-eslint/no-explicit-any */ } />,
+	<Chessboard colorset="not-a-colorset" />,
+	<Chessboard pieceset="not-a-pieceset" />,
 ]); /* eslint-enable react/jsx-key */