typing-game-cli 4.0.0 → 6.0.0

package/dist/Results.js

@@ -2,13 +2,19 @@ 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,
+  topN
 }) {
-  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",
@@ -22,7 +28,8 @@ export default function Results({
     flexDirection: "column"
   }, getResults({
     sortBy: '-cpm',
-    showAll: false
+    showAll: false,
+    topN
   }).map((result, i, array) => /*#__PURE__*/React.createElement(Box, {
     key: nanoid(),
     justifyContent: "center",

package/dist/app.js

@@ -7,7 +7,7 @@ import Gradient from 'ink-gradient';
 import { proxy, useSnapshot } from 'valtio';
 import random from 'just-random';
 import { formatISO } from 'date-fns';
-import { getBorderColor, getDefaultSuite, getRobotBorderColor, getStatusVariant, getMessageOrPlaceholder, isFinished, isWordTyped, calculateWPM, getTypingWord, getRemainingPart, getWpmTextColor, calculateCPS, calculateCPM, getBestResult, getScoreTextColor, getCompetitionResult, registerResult, registerBestFrames, getBestFrames, getOpponentFrames } from './helpers.js';
+import { getBorderColor, getDefaultSuite, getRobotBorderColor, getStatusVariant, getMessageOrPlaceholder, isFinished, isWordTyped, calculateWPM, getTypingWord, getRemainingPart, getWpmTextColor, calculateCPS, calculateCPM, getBestResult, getScoreTextColor, getCompetitionResult, registerResult, registerBestFrames, getBestFrames, getOpponentFrames, getSuiteByTopic } from './helpers.js';
 import { optionKeyColor } from './constants.js';
 import Results from './Results.js';
 import { config } from './config.js';
@@ -16,12 +16,13 @@ import { exitNow } from './cli.js';
 const currentTime = () => Date.now();
 const state = proxy({
   status: 'PAUSED',
+  topic: null,
   suite: getDefaultSuite(),
   source: null,
   firstPart: '',
   highlightedPart: '',
   erroredPart: '',
-  highlighingColor: 'green',
+  highlightingColor: 'green',
   showOkCancelQuestion: false,
   gameOver: false,
   okCancelMessage: '',
@@ -53,14 +54,18 @@ const state = proxy({
   isTimerVisible: true,
   timerVisibilityCounter: 0,
   isAnimatingEnd: false,
-  showGameResult: false
+  showGameResult: false,
+  topN: undefined
 });
 export default function App({
   robotLevel,
+  topic,
   displayResults = false,
   sortBy,
   isShowAllHistory,
-  isCompetingAgainstBestResult
+  isCompactFormat,
+  isCompetingAgainstBestResult,
+  topN
 }) {
   const snap = useSnapshot(state);
   const {
@@ -76,7 +81,14 @@ export default function App({
     if (isCompetingAgainstBestResult) {
       state.isAgainstMyselft = true;
     }
-  }, [displayResults, isCompetingAgainstBestResult]);
+    if (topN) {
+      state.topN = topN;
+    }
+    if (topic) {
+      state.topic = topic;
+      state.suite = getSuiteByTopic(topic);
+    }
+  }, [displayResults, isCompetingAgainstBestResult, topN, topic]);
   useInput((input, key) => {
     if (input === 'y') {
       const foundBestResult = getBestResult();
@@ -214,7 +226,9 @@ export default function App({
   if (snap.status === 'RESULTS') {
     return /*#__PURE__*/React.createElement(Results, {
       sortBy: sortBy,
-      isShowAllHistory: isShowAllHistory
+      isShowAllHistory: isShowAllHistory,
+      isCompactFormat: isCompactFormat,
+      topN: topN
     });
   }
   return snap.status === 'PAUSED' ? /*#__PURE__*/React.createElement(Box, {

package/dist/cli.js

@@ -24,7 +24,9 @@ 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)
+		  --topic           Use sentences from works written by specified author
+	      --top-n           Display top n results in displaying results mode
 
 		Short flags and aliases for options:
 		  --against-my-best:  -b, --best, --my-best, --myself, --against-my-best-result
@@ -36,6 +38,8 @@ const cli = meow(`
 		  --sort-by           -s
 		  --show-all-history: -a, --all, --all-history
 		  --clear-results:    -c, --clear
+		  --topic:            --author
+		  --top-n:            --top
 
 
 		Examples
@@ -47,11 +51,14 @@ const cli = meow(`
 		  $ typing-game-cli -m
 		  $ typing-game-cli --low
 		  $ typing-game-cli --display-results
+		  $ typing-game-cli --display-results --top 5
 		  $ typing-game-cli -r
 		  $ typing-game-cli -r --sort-by="-wpm"
 		  $ typing-game-cli -r -s="wpm"
 		  $ typing-game-cli -r -s="-wpm" --all-history
 		  $ typing-game-cli -r -s="-wpm" -a
+		  $ typing-game-cli --topic mark-twain
+		  $ typing-game-cli --author ambrose-bierce
 	`, {
   importMeta: import.meta,
   flags: {
@@ -99,6 +106,19 @@ const cli = meow(`
       shortFlag: 'b',
       aliases: ['best', 'myBest', 'myself', 'againstMyBestResult'],
       default: false
+    },
+    compactResult: {
+      type: 'boolean',
+      aliases: ['cmpc'],
+      default: false
+    },
+    topN: {
+      type: 'number',
+      aliases: ['top']
+    },
+    topic: {
+      type: 'string',
+      aliases: ['author']
     }
   }
 });
@@ -113,13 +133,19 @@ const {
   displayResults,
   sortBy,
   showAllHistory,
-  againstMyBest
+  againstMyBest,
+  compactResult,
+  topN,
+  topic
 } = 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,
+  topN: topN,
+  topic: topic
 }));
 export { exitNow };

package/dist/helpers.js

@@ -3,8 +3,9 @@ import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { fdir as Fdir } from 'fdir';
 import random from 'just-random';
+import compose from 'just-compose';
 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);
@@ -15,6 +16,13 @@ const sourcesPath = path.join(__dirname, 'sentences');
 const isWon = value => value === won;
 const isLost = value => value === lost;
 const files = new Fdir().filter((path, _isDirectory) => path.endsWith('.json')).withFullPaths().crawl(sourcesPath).sync();
+const getFilesByTopic = topic => {
+  return new Fdir().filter((path, _isDirectory) => path.endsWith('.json')).withFullPaths().crawl(path.join(sourcesPath, topic)).sync();
+};
+const readFile = file => fs.readFileSync(file, 'utf8');
+const getSuiteByTopic = topic => {
+  return compose(getFilesByTopic, random, readFile, JSON.parse)(topic);
+};
 const getDefaultSuite = () => {
   return JSON.parse(fs.readFileSync(random(files), 'utf8'));
 };
@@ -109,7 +117,8 @@ const getRemainingPart = (source, typed, hasErroredPart = false) => {
 };
 const getResults = ({
   sortBy: sortByValue = '-wpm',
-  showAll = false
+  showAll = false,
+  topN
 }) => {
   const config = new Config();
   const data = config.get();
@@ -140,7 +149,7 @@ const getResults = ({
     return -parseISO(item.date);
   });
   if (!showAll) {
-    return result.slice(0, 10);
+    return result.slice(0, topN === undefined ? 10 : topN);
   }
   return result;
 };
@@ -159,6 +168,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 +219,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, getSuiteByTopic, registerResult, registerBestFrames };

package/dist/sentences/ambrose-bierce/what-occured-at-franklin.json

@@ -0,0 +1,16 @@
+{
+	"sentences": [
+		"For several days, in snow and rain, General Schofield's little army had crouched in its hastily constructed defenses at Columbia, Tennessee. It had retreated in hot haste from Pulaski, thirty miles to the south, arriving just in time to foil Hood, who, marching from Florence, Alabama, by another road, with a force of more than double our strength, had hoped to intercept us. Had he succeeded, he would indubitably have bagged the whole bunch of us.",
+		"As it was, he simply took position in front of us and gave us plenty of employment, but did not attack; he knew a trick worth two of that. Duck River was directly in our rear; I suppose both our flanks rested on it. The town was between them. One night--that of November 27, 1864--we pulled up stakes and crossed to the north bank to continue our retreat to Nashville, where Thomas and safety lay - such safety as is known in war.",
+		"It was high time too, for before noon of the next day Forrest's cavalry forded the river a few miles above us and began pushing back our own horse toward Spring Hill, ten miles in our rear, on our only road. Why our infantry was not immediately put in motion toward the threatened point, so vital to our safety, General Schofield could have told better than I. Howbeit, we lay there inactive all day. The next morning - a bright and beautiful one - the brigade of Colonel P. Sidney Post was thrown out, up the river four or five miles, to see what it could see.",
+		"What it saw was Hood's head-of-column coming over on a pontoon bridge, and a right pretty spectacle it would have been to one whom it did not concern. It concerned us rather keenly. As a member of Colonel Post's staff, I was naturally favored with a good view of the performance. We formed in line of battle at a distance of perhaps a half-mile from the bridge-head, but that unending column of gray and steel gave us no more attention than if we had been a crowd of farmer-folk. Why should it?",
+		"It had only to face to the left to be itself a line of battle. Meantime it had more urgent business on hand than brushing away a small brigade whose only offense was curiosity; it was making for Spring Hill with all its legs and wheels. Hour after hour we watched that unceasing flow of infantry and artillery toward the rear of our army. It was an unnerving spectacle, yet we never for a moment doubted that, acting on the intelligence supplied by our succession of couriers, our entire force was moving rapidly to the point of contact. The battle of Spring Hill was obviously decreed.",
+		"Obviously, too, our brigade of observation would be among the last to have a hand in it. The thought annoyed us, made us restless and resentful. Our mounted men rode forward and back behind the line, nervous and distressed; the men in the ranks sought relief in frequent changes of posture, in shifting their weight from one leg to the other, in needless inspection of their weapons and in that unfailing resource of the discontented soldier, audible damning of those in the saddles of authority. But never for more than a moment at a time did anyone remove his eyes from that fascinating and portentous pageant.",
+		"Toward evening we were recalled, to learn that of our five divisions of infantry, with their batteries, numbering twenty-three thousand men, only one--Stanley's, four thousand weak--had been sent to Spring Hill to meet that formidable movement of Hood's three veteran corps! Why Stanley was not immediately effaced is still a matter of controversy. Hood, who was early on the ground, declared that he gave the needful orders and tried vainly to enforce them; Cheatham, in command of his leading corps, declared that he did not.",
+		"Doubtless the dispute is still being carried on between these chieftains from their beds of asphodel and moly in Elysium. So much is certain: Stanley drove away Forrest and successfully held the junction of the roads against Cleburne's division, the only infantry that attacked him. That night the entire Confederate army lay within a half mile of our road, while we all sneaked by, infantry, artillery, and trains. The enemy's camp-fires shone redly - miles of them - seeming only a stone's throw from our hurrying column.",
+		"His men were plainly visible about them, cooking their suppers - a sight so incredible that many of our own, thinking them friends, strayed over to them and did not return. At intervals of a few hundred yards we passed dim figures on horseback by the roadside, enjoining silence. Needless precaution; we could not have spoken if we had tried, for our hearts were in our throats. But fools are God's peculiar care, and one of his protective methods is the stupidity of other fools. By daybreak our last man and last wagon had passed the fateful spot unchallenged, and our first were entering Franklin, ten miles away.",
+		"Despite spirited cavalry attacks on trains and rear-guard, all were in Franklin by noon and such of the men as could be kept awake were throwing up a slight line of defense, inclosing the town. Franklin lies - or at that time did lie; I know not what exploration might now disclose - on the south bank of a small river, the Harpeth by name. For two miles southward was a nearly flat, open plain, extending to a range of low hills through which passed the turnpike by which we had come.",
+		"From some bluffs on the precipitous north bank of the river was a commanding overlook of all this open ground, which, although more than a mile away, seemed almost at one's feet. On this elevated ground the wagon-train had been parked and General Schofield had stationed himself - the former for security, the latter for outlook. Both were guarded by General Wood's infantry division, of which my brigade was a part. \"We are in beautiful luck,\" said a member of the division staff. With some prevision of what was to come and a lively recollection of the nervous strain of helpless observation, I did not think it luck."
+	],
+	"tags": ["ambrose-bierce", "what-occured-at-franklin"]
+}

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": "6.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,9 @@ $ 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
+    --topic           Use sentences from works written by specified author
+    --top-n           Display top n results when `--display-results` is being used
 
   Short flags and aliases for options:
     --against-my-best:  -b, --best, --my-best, --myself, --against-my-best-result
@@ -41,6 +44,9 @@ $ npm install --global typing-game-cli
     --sort-by           -s
     --show-all-history: -a, --all, --all-history
     --clear-results:    -c, --clear
+    --compact-result    --cmpc
+    --topic             --author
+    --top-n             --top
 
 
   Examples
@@ -52,11 +58,14 @@ $ npm install --global typing-game-cli
     $ typing-game-cli -m
     $ typing-game-cli --low
     $ typing-game-cli --display-results
+    $ typing-game-cli --display-results --top 3
     $ typing-game-cli -r
     $ typing-game-cli -r --sort-by="-wpm"
     $ typing-game-cli -r -s="wpm"
     $ typing-game-cli -r -s="-wpm" --all-history
     $ typing-game-cli -r -s="-wpm" -a
+    $ typing-game-cli --topic ambrose-bierce
+    $ typing-game-cli --author mark-twain
 ```
 
 ## Demo
@@ -65,7 +74,7 @@ $ npm install --global typing-game-cli
 
 ## Screenshots
 
-### Competition agains fast robot
+### Competition against fast robot
 
 ```
 $ typing-game-cli --fast
@@ -73,7 +82,7 @@ $ typing-game-cli --fast
 
 ![](media/competition-against-fast-robot.png)
 
-### Competition agains best result
+### Competition against best result
 
 ```
 $ typing-game-cli --my-best
@@ -91,6 +100,10 @@ $ tgc -b
 
 ![](media/competition-against-best-result-2.png)
 
+#### Example - Display top n results
+
+![](media/display-top-n-results.png)
+
 ## License
 
 MIT © [Rushan Alyautdinov](https://github.com/akgondber)