typing-game-cli 7.0.0 → 7.1.0

package/dist/cli.js

@@ -7,6 +7,7 @@ import compose from 'just-compose';
 import filter from 'just-filter-object';
 import App from './app.js';
 import { config } from './config.js';
+import { getBestWpmResult, getGoal, wasGoalAchieved } from './helpers.js';
 const cli = meow(`
 		Usage
 		  $ typing-game-cli
@@ -29,6 +30,8 @@ const cli = meow(`
 		  --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
+		  --set-goal        Set a goal (in wpm) that you wish to achieve
+		  --goal-achieved   Let you know whether a goal was achieved
 
 		Short flags and aliases for options:
 		  --against-my-best:  -b, --best, --my-best, --myself, --against-my-best-result
@@ -44,6 +47,8 @@ const cli = meow(`
 		  --top-n:            --top
 		  --handicap          --ha, --hndcp, --hdc, --han
 		  --handicap-count    --hanco, --hanCo, --hndco, --haco
+		  --set-goal          --sgoal, --goal
+		  --goal-achieved     --goalach, --coolprogress, --progone, --goaldone, --aic
 
 
 		Examples
@@ -63,6 +68,9 @@ const cli = meow(`
 		  $ typing-game-cli -r -s="-wpm" -a
 		  $ typing-game-cli --topic mark-twain
 		  $ typing-game-cli --topic ambrose-bierce
+		  $ typing-game-cli --set-goal 60
+		  $ typing-game-cli --goal 60
+		  $ typing-game-cli --goal-achieved
 	`, {
   importMeta: import.meta,
   flags: {
@@ -91,6 +99,14 @@ const cli = meow(`
       type: 'number',
       aliases: ['hanco', 'hanCo', 'hndco', 'haco']
     },
+    setGoal: {
+      type: 'string',
+      aliases: ['sgoal', 'goal']
+    },
+    goalAchieved: {
+      type: 'boolean',
+      aliases: ['goalach', 'coolprogress', 'progrone', 'progone', 'goaldone', 'aic']
+    },
     displayResults: {
       type: 'boolean',
       shortFlag: 'r',
@@ -141,6 +157,24 @@ if (cli.flags.clearResults) {
   config.clearAll();
   exitNow();
 }
+if (cli.flags.setGoal) {
+  config.appendGoal(cli.flags.setGoal);
+  exitNow();
+}
+if (cli.flags.goalAchieved) {
+  const achiemenceResult = wasGoalAchieved();
+  if (achiemenceResult === null) {
+    console.log(`There are no goal yet. First set a goal by --set-goal [wpm] command`);
+  } else {
+    let messageToSay = achiemenceResult ? `Congrats, you have achieved your goal.` : `You goal is not achieved yet.`;
+    if (!achiemenceResult) {
+      const bestResult = getBestWpmResult();
+      messageToSay += ` Best result - ${bestResult.value.wpm}, goal - ${getGoal()}. Keep trying, don't give up!`;
+    }
+    console.log(messageToSay);
+  }
+  exitNow();
+}
 const robotLevel = compose(flags => pick(flags, ['extraFast', 'fast', 'medium', 'low']), flags => filter(flags, (_, value) => value), flags => Object.keys(flags)[0] || 'medium')(cli.flags);
 const {
   handicap,

package/dist/config.js

@@ -1,6 +1,7 @@
 import fs from 'node:fs';
 import os from 'node:os';
 import { join } from 'node:path';
+import { formatISO } from 'date-fns';
 const defaultConfig = {};
 export default class Config {
   constructor() {
@@ -29,10 +30,27 @@ export default class Config {
       ...previous,
       ...entry
     }, null, 4);
-    fs.writeFileSync(this._configFile, data, 'utf8');
+    this.persist(data);
+  }
+  appendGoal(wpm) {
+    const previous = this.get();
+    const currentGoals = previous.goals || [];
+    currentGoals.push({
+      wpm,
+      date: formatISO(new Date())
+    });
+    const data = JSON.stringify({
+      ...previous,
+      goals: currentGoals,
+      goal: wpm
+    }, null, 4);
+    this.persist(data);
   }
   clearAll() {
-    fs.writeFileSync(this._configFile, '{}', 'utf8');
+    this.persist('{}');
+  }
+  persist(data) {
+    fs.writeFileSync(this._configFile, data, 'utf8');
   }
 }
 export const config = new Config();

package/dist/helpers.js

@@ -225,6 +225,22 @@ const getResults = ({
   }
   return result;
 };
+const getGoal = () => {
+  const config = new Config();
+  const data = config.get();
+  return data.goal;
+};
+const wasGoalAchieved = () => {
+  const goal = getGoal();
+  if (goal) {
+    const bestResult = getBestWpmResult();
+    if (bestResult === undefined) {
+      return false;
+    }
+    return goal <= bestResult.value.wpm;
+  }
+  return null;
+};
 const getBestResult = () => {
   const config = new Config();
   const data = config.get();
@@ -291,4 +307,4 @@ const registerBestFrames = (config, frames) => {
     bestFrames: frames
   });
 };
-export { getDefaultSuite, getStatusVariant, getSentencesSkippingWords, getHaLeft, getHaCount, getWpmTextColor, getScoreTextColor, getMessage, getMessageOrPlaceholder, getBorderColor, getRobotBorderColor, getIntervalMs, isFinished, isWordTyped, isLastNumber as isLastNum, isAboutToFinish, calculateWPM, calculateCPS, calculateCPM, getCompetitionResult, getTypingWord, getRemainingPart, getResults, getBestResult, getBestResultCompactString, getBestFrames, getOpponentFrames, getResultByWordCount, getBestWpmResult, getSortedByString, getWordCount, getSuiteByTopic, registerResult, registerBestFrames };
+export { getDefaultSuite, getStatusVariant, getSentencesSkippingWords, getHaLeft, getHaCount, getWpmTextColor, getScoreTextColor, getMessage, getMessageOrPlaceholder, getBorderColor, getRobotBorderColor, getIntervalMs, getGoal, isFinished, isWordTyped, isLastNumber as isLastNum, isAboutToFinish, calculateWPM, calculateCPS, calculateCPM, getCompetitionResult, getTypingWord, getRemainingPart, getResults, getBestResult, getBestResultCompactString, getBestFrames, getOpponentFrames, getResultByWordCount, getBestWpmResult, getSortedByString, getWordCount, getSuiteByTopic, registerResult, registerBestFrames, wasGoalAchieved };

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": "7.0.0",
+	"version": "7.1.0",
 	"homepage": "https://github.com/akgondber/typing-game-cli",
 	"repository": "akgondber/typing-game-cli",
 	"author": "Rushan Alyautdinov <akgondber@gmail.com>",
@@ -114,6 +114,7 @@
 		"typingpracrice",
 		"bestresult",
 		"terminalgame",
-		"cligame"
+		"cligame",
+		"typingspeed"
 	]
 }

package/readme.md

@@ -28,13 +28,15 @@ $ npm install --global typing-game-cli
     --medium          Start a round with a robot having medium typing speed.
     --low             Start a round with a robot having low typing speed.
     --handicap        Start a round with handicap given by opponent to you by specified count of chars
-		--handicap-count  How many chars you wish to ask from opponent
+    --handicap-count  How many chars you wish to ask from opponent
     --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
+    --set-goal        Set a goal (in wpm) that you wish to achieve
+    --goal-achieved   Let you know whether a goal was achieved
 
   Short flags and aliases for options:
     --against-my-best:  -b, --best, --my-best, --myself, --against-my-best-result
@@ -49,6 +51,10 @@ $ npm install --global typing-game-cli
     --compact-result    --cmpc
     --topic             --author
     --top-n             --top
+    --handicap          --ha, --hndcp, --hdc, --han
+    --handicap-count    --hanco, --hanCo, --hndco, --haco
+    --set-goal          --sgoal, --goal
+    --goal-achieved     --goalach, --coolprogress, --progone, --goaldone, --aic
 
 
   Examples