Merge pull request #5 from kikiklang/line-wrapper

Line wrapper

Author: kikiklang

cli.js

@@ -2,9 +2,9 @@
 'use strict'
 
 const meow = require('meow')
-const updateNotifier = require('update-notifier');
+const updateNotifier = require('update-notifier')
 const help = require('./src/help')
-const pkg = require('./package.json');
+const pkg = require('./package.json')
 const launch = require('./index')
 
 const cli = meow(help, {
@@ -32,7 +32,7 @@ const cli = meow(help, {
   }
 })
 
-updateNotifier({pkg}).notify();
+updateNotifier({pkg}).notify()
 
 launch.wikipediaCLI(cli.flags)
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "wiclipedia",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "wikipedia articles summaries in your terminal",
   "repository": "kikiklang/wiclipedia",
   "homepage": "https://github.com/kikiklang/wiclipedia",
@@ -37,7 +37,6 @@
   ],
   "dependencies": {
     "boxen": "^4.2.0",
-    "clear": "^0.1.0",
     "configstore": "^5.0.1",
     "iso-639-1": "^2.1.3",
     "kleur": "^4.0.0",

package.json

@@ -43,7 +43,7 @@ exports.storeSearches = (userInput, lang) => {
   this.model.set('history', history)
 }
 
-exports.clear = () => {
+exports.clearHistory = () => {
   this.model.set('history', [])
 }
 

src/config.js

@@ -6,7 +6,6 @@
 
 const qoa = require('qoa')
 const boxen = require('boxen')
-const clear = require('clear')
 const {italic, yellow, red, bold} = require('kleur')
 
 const header = require('./header')
@@ -15,9 +14,14 @@ const prompt = require('./prompt')
 const config = require('./config')
 const options = require('./boxen-options')
 
+/**
+ * Check the user's answer picked from the prompt.
+ * Check specifically if the user decided to quit the program or wanted to make another search
+ * @param  {String} input The picked choice after prompt
+ */
 function _checkUserAnswers(input) {
   if (input.userPick.includes('(Try another search)')) {
-    clear()
+    process.stdout.write('\u001Bc') // Clear the console
     header.logAppName()
     prompt.topicInteractive.menu = []
     return _search()
@@ -28,6 +32,11 @@ function _checkUserAnswers(input) {
   }
 }
 
+/**
+ * Fill an array with all possibles values for interactive menu based prompt
+ * @param  {Array} topics set of values coming from wikipedia API
+ * @param  {String} promptName Allow to pick the right prompt
+ */
 function _fillInteractiveTopicsName(topics, promptName) {
   topics.forEach(item => {
     prompt[promptName].menu.push(item.title)
@@ -36,14 +45,47 @@ function _fillInteractiveTopicsName(topics, promptName) {
   prompt[promptName].menu.push(red('(Quit)'))
 }
 
+/**
+ * Log / display the article summaries choosen by the user
+ * @param  {Object} result the response object received from the API call
+ */
 function _displayArticle(result) {
   const articleName = bold(result.title)
   const link = yellow(result.url)
+  const lineLength = process.stdout.columns
 
   console.log(boxen(`${articleName} - ${link}`, options.boxenOptions('blue')))
-  console.log(result.text)
+  console.log(lineLength < 85 ? result.text : _lineWrapper(result.text))
 }
 
+/**
+ * Format the logged article summary to avoid long line of text and offer better reading experience
+ * @param  {String} text the summary received from the API call
+ */
+function _lineWrapper(text) {
+  let index = 0
+  return text
+    .split('')
+    .map(char => {
+      if (char === '\n') {
+        index = 0
+      }
+
+      if (char === ' ' && index > 80) {
+        char = '\n'
+        index = 0
+      }
+
+      index++
+      return char
+    }).join('')
+}
+
+/**
+ * Display a prompt that helps user to set a language
+ * Save the answer to a json file
+ * Display a confirmation to the user
+ */
 async function _askForlanguage() {
   const isLangAlreadySet = await config.checkLang()
   if (!isLangAlreadySet) {
@@ -55,13 +97,24 @@ async function _askForlanguage() {
   }
 }
 
+/**
+ * Display a prompt that ask the user to choose a topic
+ * check the stored language config
+ * call the wikipedia API for a set of topics
+ */
 async function _askForATopic() {
   const input = await qoa.prompt(prompt.topicQuestion)
   const lang = await config.checkLang()
   const suggestedTopics = await fetch.getSuggestedTopic(input.userSearch, lang)
   _fillInteractiveTopicsName(suggestedTopics, 'topicInteractive')
 }
 
+/**
+ * Display a prompt that ask the user to choose between a list of topics
+ * check the stored language config
+ * call the wikipedia API to request the choosen article
+ * save the search
+ */
 async function _refineTopics() {
   const input = await qoa.interactive(prompt.topicInteractive)
   await _checkUserAnswers(input)
@@ -73,15 +126,21 @@ async function _refineTopics() {
   prompt.topicInteractive.menu = []
 }
 
+/**
+ * Just calling other functions
+ */
 async function _search() {
   await _askForATopic()
   await _refineTopics()
 }
 
+/**
+ * Check if the user wants to make another research
+ */
 async function _searchAgain() {
   const input = await qoa.confirm(prompt.topicRedo)
   if (input.redo) {
-    clear()
+    process.stdout.write('\u001Bc') // Clear the console
     await header.logAppName()
     await _search()
     await _searchAgain()
@@ -92,6 +151,9 @@ async function _searchAgain() {
   }
 }
 
+/**
+ * Bootstrap the app
+ */
 exports.launchProgram = async () => {
   await config.model
   await header.logAppName()
@@ -100,6 +162,9 @@ exports.launchProgram = async () => {
   await _searchAgain()
 }
 
+/**
+ * Allow the user to specify a language for the displayed articles
+ */
 exports.setLang = async () => {
   console.log(italic('full ISO codes list here -> https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes'))
   const input = await qoa.prompt(prompt.langQuestion)
@@ -109,12 +174,18 @@ exports.setLang = async () => {
   console.log(`you chose: ${name} (${nativeName})`)
 }
 
+/**
+ * Allow the user to delete all previous searches
+ */
 exports.clearHistory = () => {
-  config.clear()
+  config.clearHistory()
 
   console.log('history is clear now')
 }
 
+/**
+ * Allow the user to display all previous searches
+ */
 exports.displayPreviousSearches = async () => {
   const history = await config.getHistory()