typing-game-cli 1.0.0

package/dist/app.js

@@ -0,0 +1,104 @@
+import React from 'react';
+import { Text, Box, useInput, useStdout } from 'ink';
+import TextInput from 'ink-text-input-2';
+import { Spinner, Alert } from '@inkjs/ui';
+import Gradient from 'ink-gradient';
+import { proxy, useSnapshot } from 'valtio';
+import random from 'just-random';
+import { getBorderColor, getDefaultSuite, getRobotBorderColor, getStatusVariant, getMessage, isFinished, getIntervalMs } from './helpers.js';
+import { optionKeyColor } from './constants.js';
+const state = proxy({
+  status: 'PAUSED',
+  suite: getDefaultSuite(),
+  source: null,
+  robotText: '',
+  userText: '',
+  intervalId: null,
+  level: 'medium'
+});
+export default function App({
+  robotLevel
+}) {
+  const snap = useSnapshot(state);
+  const {
+    stdout
+  } = useStdout();
+  useInput((input, _key) => {
+    if (input === 'y') {
+      state.userText = '';
+      state.robotText = '';
+      state.status = 'RUNNING';
+      state.source = random(state.suite.sentences);
+      state.level = robotLevel || 'medium';
+      const interval = setInterval(() => {
+        state.robotText += state.source.slice(state.robotText.length, state.robotText.length + 1);
+        if (state.robotText === state.source) {
+          state.status = 'LOST';
+          clearInterval(interval);
+        } else if (state.userText === state.source) {
+          state.status = 'WON';
+          clearInterval(interval);
+        }
+      }, getIntervalMs(state.level));
+      state.intervalId = interval;
+    }
+  }, {
+    isActive: state.status !== 'RUNNING'
+  });
+  return snap.status === 'PAUSED' ? /*#__PURE__*/React.createElement(Box, {
+    flexDirection: "column",
+    alignItems: "center"
+  }, /*#__PURE__*/React.createElement(Box, {
+    marginY: 2,
+    flexDirection: "column",
+    justifyContent: "center"
+  }, /*#__PURE__*/React.createElement(Gradient, {
+    name: "rainbow"
+  }, /*#__PURE__*/React.createElement(Text, null, "TYPING-GAME-CLI"))), /*#__PURE__*/React.createElement(Box, {
+    rowGap: 1,
+    flexDirection: "column",
+    justifyContent: "center",
+    alignItems: "center"
+  }, /*#__PURE__*/React.createElement(Text, null, "Typer-robot challenges you: who will type a text faster."), /*#__PURE__*/React.createElement(Text, null, "Press", ' ', /*#__PURE__*/React.createElement(Text, {
+    bold: true,
+    color: optionKeyColor
+  }, "y"), ' ', "if you want to accept a challenge and start a round."))) : /*#__PURE__*/React.createElement(Box, {
+    flexDirection: "column",
+    alignItems: "center"
+  }, isFinished(snap.status) ? /*#__PURE__*/React.createElement(Box, {
+    flexDirection: "column"
+  }, /*#__PURE__*/React.createElement(Box, {
+    paddingY: 1
+  }, /*#__PURE__*/React.createElement(Text, null, "Press", ' ', /*#__PURE__*/React.createElement(Text, {
+    bold: true,
+    color: optionKeyColor
+  }, "y"), ' ', "to start a new round.")), /*#__PURE__*/React.createElement(Box, {
+    flexDirection: "column",
+    alignItems: "center",
+    justifyContent: "center"
+  }, /*#__PURE__*/React.createElement(Box, null, /*#__PURE__*/React.createElement(Alert, {
+    variant: getStatusVariant(snap.status)
+  }, getMessage(snap.status))))) : /*#__PURE__*/React.createElement(Box, null, /*#__PURE__*/React.createElement(Box, {
+    borderStyle: "single",
+    alignItems: "center",
+    justifyContent: "center"
+  }, /*#__PURE__*/React.createElement(Spinner, null), /*#__PURE__*/React.createElement(Text, null, " Running"))), /*#__PURE__*/React.createElement(Box, {
+    paddingBottom: 1
+  }, /*#__PURE__*/React.createElement(Text, null, snap.source)), /*#__PURE__*/React.createElement(Box, {
+    alignItems: "center",
+    justifyContent: "center"
+  }, /*#__PURE__*/React.createElement(Box, {
+    borderStyle: "single",
+    width: stdout.columns / 2.15,
+    borderColor: getBorderColor(snap.status)
+  }, isFinished(snap.status) ? /*#__PURE__*/React.createElement(Text, null, snap.userText) : /*#__PURE__*/React.createElement(TextInput, {
+    value: snap.userText,
+    onChange: value => {
+      state.userText = value;
+    }
+  })), /*#__PURE__*/React.createElement(Box, {
+    borderStyle: "single",
+    width: stdout.columns / 2.15,
+    borderColor: getRobotBorderColor(snap.status)
+  }, /*#__PURE__*/React.createElement(Text, null, snap.robotText))));
+}

package/dist/cli.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+import React from 'react';
+import { render } from 'ink';
+import meow from 'meow';
+import pick from 'just-pick';
+import compose from 'just-compose';
+import filter from 'just-filter-object';
+import App from './app.js';
+const cli = meow(`
+		Usage
+		  $ typing-game-cli
+
+		Options
+			--fast   Start a round with a robot having high typing speed.
+			--medium Start a round with a robot having medium typing speed.
+			--low    Start a round with a robot having low typing speed.
+
+		Examples
+		  $ typing-game-cli
+		  $ typing-game-cli --fast
+		  $ typing-game-cli --medium
+		  $ typing-game-cli --low
+	`, {
+  importMeta: import.meta,
+  flags: {
+    fast: {
+      type: 'boolean',
+      shortFlag: 'f'
+    },
+    medium: {
+      type: 'boolean',
+      shortFlag: 'm'
+    },
+    low: {
+      type: 'boolean',
+      shortFlag: 'l'
+    }
+  }
+});
+const robotLevel = compose(flags => pick(flags, ['fast', 'medium', 'low']), flags => filter(flags, (_, value) => value), flags => Object.keys(flags)[0] || 'medium')(cli.flags);
+render( /*#__PURE__*/React.createElement(App, {
+  robotLevel: robotLevel
+}));

package/dist/constants.js

@@ -0,0 +1,2 @@
+const optionKeyColor = '#B85042';
+export { optionKeyColor };

package/dist/helpers.js

@@ -0,0 +1,43 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { fdir as Fdir } from 'fdir';
+import random from 'just-random';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const won = 'WON';
+const lost = 'LOST';
+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 getDefaultSuite = () => {
+  return JSON.parse(fs.readFileSync(random(files), 'utf8'));
+};
+const getStatusVariant = status => {
+  if (isWon(status)) return 'success';
+  if (isLost(status)) return 'error';
+  return '';
+};
+const getMessage = status => {
+  if (isWon(status)) return 'You won!';
+  if (isLost(status)) return 'Robot won!';
+  return '';
+};
+const getBorderColor = status => {
+  if (isWon(status)) return 'green';
+  return '';
+};
+const getRobotBorderColor = status => {
+  if (isLost(status)) return 'green';
+  return '';
+};
+const getIntervalMs = level => {
+  return {
+    fast: 270,
+    medium: 380,
+    low: 1600
+  }[level];
+};
+const isFinished = status => [won, lost].includes(status);
+export { getDefaultSuite, getStatusVariant, getMessage, getBorderColor, getRobotBorderColor, getIntervalMs, isFinished };

package/dist/sentences/ambrose-bierce/moxon-s-master.json

@@ -0,0 +1,24 @@
+{
+	"sentences": [
+		"Had it affected his mind? His reply to my question seemed to me then evidence that it had; perhaps I should think differently about it now.",
+		"In an open spot in my garden I planted a climbing vine. When it was barely above the surface I set a stake into the soil a yard away.",
+		"The vine at once made for it, but as it was about to reach it after several days I removed it a few feet. The vine at once altered its course, making an acute angle, and again made for the stake.",
+		"We were speaking, not of plants, but of machines. They may be composed partly of wood  -  wood that has no longer vitality  -  or wholly of metal.",
+		"When soldiers form lines, or hollow squares, you call it reason. When wild geese in flight take the form of a letter V you say instinct.",
+		"I read it thirty years ago. He may have altered it afterward, for anything I know, but in all that time I have been unable to think of a single word that could profitably be changed or added or removed.",
+		"At each recurrence it broadened in meaning and deepened in suggestion. Why, here (I thought) is something upon which to found a philosophy.",
+		"I was drenched with rain, but felt no discomfort. Unable in my excitement to find the doorbell I instinctively tried the knob.",
+		"What I saw took all philosophical speculation out of me in short order. Moxon sat facing me at the farther side of a small table upon which a single candle made all the light that was in the room.",
+		"Opposite him, his back toward me, sat another person. On the table between the two was a chess-board; the men were playing.",
+		"His face was ghastly white, and his eyes glittered like diamonds. Of his antagonist I had only a back view, but that was sufficient; I should not have cared to see his face.",
+		"With a scarcely conscious rebellion against the indelicacy of the act I remained. The play was rapid.",
+		"There was something unearthly about it all, and I caught myself shuddering. But I was wet and cold.",
+		"Two or three times after moving a piece the stranger slightly inclined his head, and each time I observed that Moxon shifted his king. All at once the thought came to me that the man was dumb.",
+		"Nor was that all, for a moment later it struck the table sharply with its clenched hand. At that gesture Moxon seemed even more startled than I: he pushed his chair a little backward, as in alarm.",
+		"The automaton sat motionless. The wind had now gone down, but I heard, at lessening intervals and progressively louder, the rumble and roll of thunder.",
+		"This I observed, then all was blackness and silence. Three days later I recovered consciousness in a hospital.",
+		"Nobody knows how you came to be there. You may have to do a little explaining.",
+		"The origin of the fire is a bit mysterious, too. My own notion is that the house was struck by lightning."
+	],
+	"tags": ["ambrose-bierce", "moxon-s-master"]
+}

package/dist/sentences/ambrose-bierce/on-a-mountain.json

@@ -0,0 +1,13 @@
+{
+	"sentences": [
+		"With what pure delight we inhaled its fragrances of spruce and pine! How we stared with something like awe at its clumps of laurel!",
+		"He was lying flat upon his stomach and was killed by being struck in the side by a nearly spent cannon-shot, that came rolling in among us. The shot remained in him until removed.",
+		"The long logs that it was our pride to cut and carry! The accuracy with which we laid them one upon another, hewn to the line and bullet-proof!",
+		"There can be no doubt that the wealthy sportsmen who have made a preserve of the Cheat Mountain region will find plenty of game if it has not died since 1861. We left it there.",
+		"The frost had begun already to whiten their deranged clothing. We were as patriotic as ever, but we did not wish to be that way.",
+		"They appeared also to have thrown off some of their clothing, which lay near by, in disorder. Their expression, too, had an added blankness - they had no faces.",
+		"As soon as the head of our straggling column had reached the spot a desultory firing had begun. One might have thought the living paid honors to the dead.",
+		"No; the firing was a military execution; the condemned, a herd of galloping swine. They had eaten our fallen, but - touching magnanimity!"
+	],
+	"tags": ["ambrose-bierce", "on-a-mountain"]
+}

package/dist/sentences/ambrose-bierce/the-spook-house.json

@@ -0,0 +1,14 @@
+{
+	"sentences": [
+		"Morgan, when he was driven from Cumberland Gap to the Ohio river by General Kirby Smith. At the time of its destruction, it had for four or five years been vacant.",
+		"Attributing this to the continuous uproar of the thunder they pushed at one of the doors, which yielded. They entered without further ceremony and closed the door.",
+		"My notion was to ascertain by stepping again into the storm whether I had been deprived of sight and hearing. I turned the doorknob and pulled open the door.",
+		"They were of different ages, or rather sizes, from infancy up, and of both sexes. All were prostrate on the floor, excepting one, apparently a young woman, who sat up, her back supported by an angle of the wall.",
+		"A babe was clasped in the arms of another and older woman. A half- grown lad lay face downward across the legs of a full-bearded man.",
+		"One or two were nearly naked, and the hand of a young girl held the fragment of a gown which she had torn open at the breast. The bodies were in various stages of decay, all greatly shrunken in face and figure.",
+		"Equidistant from one another and from the top and bottom, three strong bolts protruded from the beveled edge. I turned the knob and they were retracted flush with the edge; released it, and they shot out.",
+		"It was a spring lock. On the inside there was no knob, nor any kind of projection - a smooth surface of iron.",
+		"A strong disagreeable odor came through the doorway, completely overpowering me. My senses reeled; I felt myself falling, and in clutching at the edge of the door for support pushed it shut with a sharp click!"
+	],
+	"tags": ["ambrose-bierce", "the-spook-house"]
+}

package/dist/sentences/ambrose-bierce/the-thing-at-nolan.json

@@ -0,0 +1,13 @@
+{
+	"sentences": [
+		"For some three years before the date mentioned above, it was occupied by the family of Charles May, from one of whose ancestors the creek near which it stands took its name.",
+		"It was observed that his clothing was wet in spots, as if (so the prosecution afterward pointed out) he had been removing blood-stains from it. His manner was strange, his look wild.",
+		"He complained of illness, and going to his room took to his bed. May senior did not return.",
+		"On Wednesday all was changed. From the town of Nolan, eight miles away, came a story which put a quite different light on the matter.",
+		"He was without hat or coat. He did not look at them, nor return their greeting, a circumstance which did not surprise, for he was evidently seriously hurt.",
+		"Counsel for the defense appears not to have demurred and the case was tried on its merits. The prosecution was spiritless and perfunctory; the defense easily established - with regard to the deceased - an alibi.",
+		"Shortly afterward his mother and sisters removed to St. Louis.",
+		"The skull had been cut through by the blow. The body was that of Charles May."
+	],
+	"tags": ["ambrose-bierce", "the-thing-at-nolan"]
+}

package/dist/sentences/mark-twain/is-he-living-or-is-he-dead.json

@@ -0,0 +1,16 @@
+{
+	"sentences": [
+		"I was spending the month of March 1892 at Mentone, in the Riviera. At this retired spot one has all the advantages, privately, which are to be had publicly at Monte Carlo and Nice, a few miles farther along.",
+		"As a rule, I mean, the rich do not come there. Now and then a rich man comes, and I presently got acquainted with one of these.",
+		"Partially to disguise him I will call him Smith. One day, in the Hotel des Anglais, at the second breakfast, he exclaimed: 'Quick!",
+		"Cast your eye on the man going out at the door. Take in every detail of him.",
+		"He is an old, retired, and very rich silk manufacturer from Lyons, they say, and I guess he is alone in the world, for he always looks sad and dreamy, and doesn't talk with anybody. His name is Theophile Magnan.",
+		"It has been a secret for many years - a secret between me and three others; but I am going to break the seal now. Are you comfortable?",
+		"He wasn't any greater than we were, then. He hadn't any fame, even in his own village; and he was so poor that he hadn't anything to feed us on but turnips, and even the turnips failed us sometimes.",
+		"We four became fast friends, doting friends, inseparables. We painted away together with all our might, piling up stock, piling up stock, but very seldom getting rid of any of it.",
+		"We had lovely times together; but, O my soul! how we were pinched now and then!",
+		"Everybody has struck - there's a league formed against us. I've been all around the village and it's just as I tell you.",
+		"Every face was blank with dismay. We realised that our circumstances were desperate, now."
+	],
+	"tags": ["marktwain", "ishelivingorishedead"]
+}

package/package.json

@@ -0,0 +1,101 @@
+{
+	"name": "typing-game-cli",
+	"description": "Command line game to practice your typing speed",
+	"version": "1.0.0",
+	"homepage": "https://github.com/akgondber/typing-game-cli",
+	"repository": "akgondber/typing-game-cli",
+	"license": "MIT",
+	"bin": {
+		"typing-game-cli": "dist/cli.js",
+		"typing-game": "dist/cli.js",
+		"tgc": "dist/cli.js",
+		"tpngm": "dist/cli.js"
+	},
+	"type": "module",
+	"engines": {
+		"node": ">=16"
+	},
+	"scripts": {
+		"build": "babel --out-dir=dist source --copy-files",
+		"dev": "babel --out-dir=dist --watch source",
+		"test": "prettier --check . && xo && ava",
+		"lint": "xo",
+		"go": "node dist/cli.js",
+		"prettify": "prettier . --write",
+		"xofix": "xo --fix"
+	},
+	"files": [
+		"dist"
+	],
+	"dependencies": {
+		"@inkjs/ui": "^1.0.0",
+		"fdir": "^6.1.1",
+		"ink": "^4.2.0",
+		"ink-gradient": "^3.0.0",
+		"ink-text-input-2": "^1.0.0",
+		"just-compose": "^2.3.0",
+		"just-curry-it": "^5.3.0",
+		"just-filter-object": "^3.2.0",
+		"just-flip": "^2.2.0",
+		"just-partial-it": "^3.4.0",
+		"just-pick": "^4.2.0",
+		"just-random": "^3.2.0",
+		"meow": "^12.0.1",
+		"react": "^18.2.0",
+		"valtio": "^1.13.0"
+	},
+	"devDependencies": {
+		"@babel/cli": "^7.22.5",
+		"@babel/preset-react": "^7.22.5",
+		"ava": "^6.1.1",
+		"chalk": "^5.2.0",
+		"eslint-config-xo-react": "^0.27.0",
+		"eslint-plugin-react": "^7.32.2",
+		"eslint-plugin-react-hooks": "^4.6.0",
+		"import-jsx": "^5.0.0",
+		"ink-testing-library": "^3.0.0",
+		"prettier": "^2.8.8",
+		"xo": "^0.54.2"
+	},
+	"ava": {
+		"environmentVariables": {
+			"NODE_NO_WARNINGS": "1"
+		},
+		"nodeArguments": [
+			"--loader=import-jsx"
+		]
+	},
+	"xo": {
+		"extends": "xo-react",
+		"prettier": true,
+		"rules": {
+			"react/prop-types": "off"
+		}
+	},
+	"prettier": {
+		"useTabs": true,
+		"semi": true,
+		"singleQuote": true,
+		"quoteProps": "as-needed",
+		"bracketSpacing": false,
+		"arrowParens": "avoid",
+		"trailingComma": "all"
+	},
+	"babel": {
+		"presets": [
+			"@babel/preset-react"
+		]
+	},
+	"keywords": [
+		"challenge",
+		"cli",
+		"fun",
+		"game",
+		"keyboard",
+		"productivity",
+		"robot",
+		"speed",
+		"typer",
+		"typing"
+	]
+}

package/readme.md

@@ -0,0 +1,44 @@
+# typing-game-cli [![NPM version][npm-image]][npm-url]
+
+> Command line game to practice your typing speed.
+
+## Install
+
+```bash
+$ npm install --global typing-game-cli
+```
+
+## CLI
+
+```
+$ typing-game-cli --help
+
+Usage
+    $ typing-game-cli
+
+  Options
+    --fast   Start a round with a robot having high typing speed.
+    --medium Start a round with a robot having medium typing speed.
+    --low    Start a round with a robot having low typing speed.
+
+  Examples
+    $ typing-game-cli
+    $ typing-game-cli --fast
+    $ typing-game-cli --medium
+    $ typing-game-cli --low
+```
+
+## Demo
+
+![](media/demo.gif)
+
+## Screenshots
+
+![](media/screenshot-1.png)
+
+## License
+
+MIT © [Rushan Alyautdinov](https://github.com/akgondber)
+
+[npm-image]: https://img.shields.io/npm/v/typing-game-cli.svg?style=flat
+[npm-url]: https://npmjs.org/package/typing-game-cli