typing-game-cli 4.0.0 → 5.0.0

package/dist/Results.js

@@ -2,13 +2,18 @@ import React from 'react';
 import { Text, Box } from 'ink';
 import { nanoid } from 'nanoid';
 import { format, parseISO } from 'date-fns';
-import { getResults, getSortedByString } from './helpers.js';
+import { getBestResultCompactString, getResults, getSortedByString } from './helpers.js';
 import Menu from './Menu.js';
 export default function Results({
   sortBy,
-  isShowAllHistory
+  isShowAllHistory,
+  isCompactFormat
 }) {
-  return /*#__PURE__*/React.createElement(Box, {
+  return isCompactFormat ? /*#__PURE__*/React.createElement(Box, {
+    flexDirection: "column",
+    justifyContent: "center",
+    paddingX: 1
+  }, /*#__PURE__*/React.createElement(Text, null, ` ${getBestResultCompactString()}`), /*#__PURE__*/React.createElement(Menu, null)) : /*#__PURE__*/React.createElement(Box, {
     flexDirection: "column"
   }, /*#__PURE__*/React.createElement(Box, {
     flexDirection: "row",

package/dist/app.js

@@ -21,7 +21,7 @@ const state = proxy({
   firstPart: '',
   highlightedPart: '',
   erroredPart: '',
-  highlighingColor: 'green',
+  highlightingColor: 'green',
   showOkCancelQuestion: false,
   gameOver: false,
   okCancelMessage: '',
@@ -60,6 +60,7 @@ export default function App({
   displayResults = false,
   sortBy,
   isShowAllHistory,
+  isCompactFormat,
   isCompetingAgainstBestResult
 }) {
   const snap = useSnapshot(state);
@@ -214,7 +215,8 @@ export default function App({
   if (snap.status === 'RESULTS') {
     return /*#__PURE__*/React.createElement(Results, {
       sortBy: sortBy,
-      isShowAllHistory: isShowAllHistory
+      isShowAllHistory: isShowAllHistory,
+      isCompactFormat: isCompactFormat
     });
   }
   return snap.status === 'PAUSED' ? /*#__PURE__*/React.createElement(Box, {

package/dist/cli.js

@@ -24,7 +24,7 @@ const cli = meow(`
 		  --low             Start a round with a robot having low typing speed.
 		  --display-results Show cpm and wpm results
 		  --sort-by         Sort results by specified value (-cpm, cpm, -wpm, wpm, -date, date), Starting "-" indicates descending order, default is "-date"
-		  --all-hostory     Show all history when displaying results (otherwise (default) display last 10 results respecting sorting parameter)
+		  --all-history     Show all history when displaying results (otherwise (default) display last 10 results respecting sorting parameter)
 
 		Short flags and aliases for options:
 		  --against-my-best:  -b, --best, --my-best, --myself, --against-my-best-result
@@ -99,6 +99,11 @@ const cli = meow(`
       shortFlag: 'b',
       aliases: ['best', 'myBest', 'myself', 'againstMyBestResult'],
       default: false
+    },
+    compactResult: {
+      type: 'boolean',
+      aliases: ['cmpc'],
+      default: false
     }
   }
 });
@@ -113,13 +118,15 @@ const {
   displayResults,
   sortBy,
   showAllHistory,
-  againstMyBest
+  againstMyBest,
+  compactResult
 } = cli.flags;
-render( /*#__PURE__*/React.createElement(App, {
+render(/*#__PURE__*/React.createElement(App, {
   robotLevel: robotLevel,
   displayResults: displayResults,
   sortBy: sortBy,
   isShowAllHistory: showAllHistory,
-  isCompetingAgainstBestResult: againstMyBest
+  isCompetingAgainstBestResult: againstMyBest,
+  isCompactFormat: compactResult
 }));
 export { exitNow };

package/dist/helpers.js

@@ -4,7 +4,7 @@ import { fileURLToPath } from 'node:url';
 import { fdir as Fdir } from 'fdir';
 import random from 'just-random';
 import sortBy from 'just-sort-by';
-import { formatISO, isValid, parseISO } from 'date-fns';
+import { format, formatISO, isValid, parseISO } from 'date-fns';
 import Config from './config.js';
 import { frames } from './robotFrames.js';
 const __filename = fileURLToPath(import.meta.url);
@@ -159,6 +159,13 @@ const getBestResult = () => {
   if (targetItems.length === 0) return null;
   return sortBy(targetItems, item => -item.value.cpm)[0];
 };
+const getBestResultCompactString = () => {
+  const result = getBestResult();
+  if (!result) {
+    return 'There is no data, please run some rounds to collect stats.';
+  }
+  return `Date: ${format(parseISO(result.date), 'MM/dd/yyyy HH:mm')}; wpm: ${result.value.wpm}; cpm: ${result.value.cpm}.`;
+};
 const getResultByWordCount = ({
   wordCount
 }) => {
@@ -203,4 +210,4 @@ const registerBestFrames = (config, frames) => {
     bestFrames: frames
   });
 };
-export { getDefaultSuite, getStatusVariant, getWpmTextColor, getScoreTextColor, getMessage, getMessageOrPlaceholder, getBorderColor, getRobotBorderColor, getIntervalMs, isFinished, isWordTyped, calculateWPM, calculateCPS, calculateCPM, getCompetitionResult, getTypingWord, getRemainingPart, getResults, getBestResult, getBestFrames, getOpponentFrames, getResultByWordCount, getBestWpmResult, getSortedByString, getWordCount, registerResult, registerBestFrames };
+export { getDefaultSuite, getStatusVariant, getWpmTextColor, getScoreTextColor, getMessage, getMessageOrPlaceholder, getBorderColor, getRobotBorderColor, getIntervalMs, isFinished, isWordTyped, calculateWPM, calculateCPS, calculateCPM, getCompetitionResult, getTypingWord, getRemainingPart, getResults, getBestResult, getBestResultCompactString, getBestFrames, getOpponentFrames, getResultByWordCount, getBestWpmResult, getSortedByString, getWordCount, registerResult, registerBestFrames };

package/dist/sentences/daphne-du-maurier/rebecca.json

@@ -0,0 +1,12 @@
+{
+	"sentences": [
+		"Last night I dreamt I went to Manderley again. It seemed to me I stood by the iron gate leading to the drive, and for a while I could not enter, for the way was barred to me. There was a padlock and a chain upon the gate. I called in my dream to the lodge-keeper, and had no answer, and peering closer through the rusted spokes of the gate I saw that the lodge was uninhabited.",
+		"There was a padlock and a chain upon the gate. I called in my dream to the lodge-keeper, and had no answer, and peering closer through the rusted spokes of the gate I saw that the lodge was uninhabited. No smoke came from the chimney, and the little lattice windows gaped forlorn. Then, like all dreamers, I was possessed of a sudden with supernatural powers and passed like a spirit through the barrier before me.",
+		"The drive wound away in front of me, twisting and turning as it had always done, but as I advanced I was aware that a change had come upon it; it was narrow and unkept, not the drive that we had known. At first I was puzzled and did not understand, and it was only when I bent my head to avoid the low swinging branch of a tree that I realised what had happened.",
+		"Nature had come into her own again and, little by, little, in her stealthy, insidious way had encroached upon the drive with long tenacious fingers. The woods, always a menace even in the past, had triumphed in the end. They crwoded, dark and uncrontrolled, to the borders of the drive. The beeches with white. naked limbs leant close to one another, their branches intermingled in a strange embrace, making a vault above my head like the archway of a church.",
+		"And there were other trees as well, trees that I did not recognise, squat oaks and tortured elms that straggled cheek by jowl with the beeches, and had trust themselves out of the quiet earth, along with monster shrubs amd plants, none of which I remembered. The drive was a ribbon now, a thread of its former self, with gravel surface gone, and choked with grass and moss. The trees had thrown out low branches, making an impediment to progress; the gnarled roots looked like skeleton claws.",
+		"Scattered here and again amongs his jungle growth I would recognise shrubs that had been land-marks in our time, things of culture and of gracem hydrangeas whose blue heads had been famous. No hand had checked their progress, and they had gone native now, rearing to monster height without a bloom, back and ugly as the nameless parasites that grew beside them.",
+		"On and on. now east, now west, would the poor thread that once had been out drive. Sometimes I thought it lost, but it appeared again, beneath a fallen tree perhaps or struggling on the other side of a muddied ditch created by the winter rains. I had not thought the way so long. Surely the miles had multiplied, even as the trees had done, and this path led but to a labirynth, some choked wilderness, and not to the house at all."
+	],
+	"tags": ["daphne-du-maurier", "maurier"]
+}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "typing-game-cli",
 	"description": "Command line game to practice your typing speed by competing against typer-robot or against your best result",
-	"version": "4.0.0",
+	"version": "5.0.0",
 	"homepage": "https://github.com/akgondber/typing-game-cli",
 	"repository": "akgondber/typing-game-cli",
 	"author": "Rushan Alyautdinov <akgondber@gmail.com>",
@@ -19,7 +19,7 @@
 	"scripts": {
 		"build": "babel --out-dir=dist source --copy-files",
 		"dev": "babel --out-dir=dist --watch source",
-		"test": "prettier --check . && xo && ava",
+		"test": "prettier --check . && xo && loadr -- ava",
 		"justtest": "ava --serial",
 		"lint": "xo",
 		"go": "node dist/cli.js",
@@ -50,13 +50,14 @@
 	},
 	"devDependencies": {
 		"@babel/cli": "^7.22.5",
-		"@babel/preset-react": "^7.22.5",
+		"@babel/preset-react": "^7.25.9",
 		"ava": "^6.1.2",
 		"eslint-config-xo-react": "^0.27.0",
 		"eslint-plugin-react": "^7.34.1",
 		"eslint-plugin-react-hooks": "^4.6.0",
 		"import-jsx": "^5.0.0",
 		"ink-testing-library": "^3.0.0",
+		"loadr": "^0.1.1",
 		"prettier": "^3.2.5",
 		"xo": "^0.58.0"
 	},
@@ -66,7 +67,8 @@
 		},
 		"nodeArguments": [
 			"--loader=import-jsx"
-		]
+		],
+		"timeout": "20s"
 	},
 	"xo": {
 		"extends": "xo-react",

package/readme.md

@@ -1,6 +1,6 @@
 # typing-game-cli [![NPM version][npm-image]][npm-url]
 
-> Command line game to practice your typing speed by competing against typer-robot or against your best result.
+> Command-line game to practice your typing speed by competing against typer-robot or against your best result.
 
 ## Install
 
@@ -30,6 +30,7 @@ $ npm install --global typing-game-cli
     --display-results Show cpm and wpm results
     --sort-by         Sort results by specified value (-cpm, cpm, -wpm, wpm, -date, date), Starting "-" indicates descending order, default is "-date"
     --all-hostory     Show all history when displaying results (otherwise (default) display last 10 results respecting sorting parameter)
+    --compact-result  Display top result in compact format
 
   Short flags and aliases for options:
     --against-my-best:  -b, --best, --my-best, --myself, --against-my-best-result
@@ -41,6 +42,7 @@ $ npm install --global typing-game-cli
     --sort-by           -s
     --show-all-history: -a, --all, --all-history
     --clear-results:    -c, --clear
+    --compact-result    --cmpc
 
 
   Examples
@@ -65,7 +67,7 @@ $ npm install --global typing-game-cli
 
 ## Screenshots
 
-### Competition agains fast robot
+### Competition against fast robot
 
 ```
 $ typing-game-cli --fast
@@ -73,7 +75,7 @@ $ typing-game-cli --fast
 
 ![](media/competition-against-fast-robot.png)
 
-### Competition agains best result
+### Competition against best result
 
 ```
 $ typing-game-cli --my-best