feat: new print func for the CLI (#931)

* refactor: CLI should use print instead of console.log #495

License: MIT
Signed-off-by: Rasmus Erik Voel Jensen <[email protected]>

* feat: add quiet/verbose CLI flag, - related to #931

License: MIT
Signed-off-by: Rasmus Erik Voel Jensen <[email protected]>

* add test, and remove verbosity levels

License: MIT
Signed-off-by: Rasmus Erik Voel Jensen <[email protected]>

Author: rasmuserik

src/cli/bin.js

@@ -6,6 +6,7 @@ const yargs = require('yargs')
 const updateNotifier = require('update-notifier')
 const readPkgUp = require('read-pkg-up')
 const utils = require('./utils')
+const print = utils.print
 
 const pkg = readPkgUp.sync({cwd: __dirname}).pkg
 updateNotifier({
@@ -14,6 +15,12 @@ updateNotifier({
 }).notify()
 
 const cli = yargs
+  .option('q', {
+    alias: 'quiet',
+    desc: 'suppress output',
+    type: 'boolean',
+    coerce: (quiet) => { if (quiet) { utils.disablePrinting() } }
+  })
   .commandDir('commands')
   .demandCommand(1)
   .fail((msg, err, yargs) => {
@@ -53,7 +60,7 @@ if (args[0] === 'daemon' || args[0] === 'init') {
       .strict(false)
       .completion()
       .parse(args, { ipfs: ipfs }, (err, argv, output) => {
-        if (output) { console.log(output) }
+        if (output) { print(output) }
 
         cleanup(() => {
           if (err) { throw err }

src/cli/commands/bitswap/stat.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const CID = require('cids')
+const print = require('../../utils').print
 
 module.exports = {
   command: 'stat',
@@ -23,7 +24,7 @@ module.exports = {
       })
       stats.Peers = stats.Peers || []
 
-      console.log(`bitswap status
+      print(`bitswap status
   blocks received: ${stats.BlocksReceived}
   dup blocks received: ${stats.DupBlksReceived}
   dup data received: ${stats.DupDataReceived}B

src/cli/commands/bitswap/wantlist.js

@@ -1,5 +1,7 @@
 'use strict'
 
+const print = require('../../utils').print
+
 module.exports = {
   command: 'wantlist',
 
@@ -20,7 +22,7 @@ module.exports = {
         throw err
       }
       res.Keys.forEach((cidStr) => {
-        console.log(cidStr)
+        print(cidStr)
       })
     })
   }

src/cli/commands/block/put.js

@@ -6,6 +6,7 @@ const bl = require('bl')
 const fs = require('fs')
 const Block = require('ipfs-block')
 const waterfall = require('async/waterfall')
+const print = require('../../utils').print
 
 function addBlock (data, opts) {
   const ipfs = opts.ipfs
@@ -26,7 +27,7 @@ function addBlock (data, opts) {
     if (err) {
       throw err
     }
-    console.log(cid.toBaseEncodedString())
+    print(cid.toBaseEncodedString())
   })
 }
 

src/cli/commands/block/rm.js

@@ -2,6 +2,7 @@
 
 const utils = require('../../utils')
 const mh = require('multihashes')
+const print = utils.print
 
 module.exports = {
   command: 'rm <key>',
@@ -21,7 +22,7 @@ module.exports = {
         throw err
       }
 
-      console.log('removed', argv.key)
+      print('removed ' + argv.key)
     })
   }
 }

src/cli/commands/block/stat.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const CID = require('cids')
+const print = require('../../utils').print
 
 module.exports = {
   command: 'stat <key>',
@@ -15,8 +16,8 @@ module.exports = {
         throw err
       }
 
-      console.log('Key:', stats.key)
-      console.log('Size:', stats.size)
+      print('Key: ' + stats.key)
+      print('Size: ' + stats.size)
     })
   }
 }

src/cli/commands/bootstrap/add.js

@@ -1,5 +1,7 @@
 'use strict'
 
+const print = require('../../utils').print
+
 module.exports = {
   command: 'add [<peer>]',
 
@@ -21,7 +23,7 @@ module.exports = {
         throw err
       }
 
-      list.Peers.forEach((l) => console.log(l))
+      list.Peers.forEach((peer) => print(peer))
     })
   }
 }

src/cli/commands/bootstrap/list.js

@@ -1,5 +1,7 @@
 'use strict'
 
+const print = require('../../utils').print
+
 module.exports = {
   command: 'list',
 
@@ -13,9 +15,7 @@ module.exports = {
         throw err
       }
 
-      list.Peers.forEach((node) => {
-        console.log(node)
-      })
+      list.Peers.forEach((node) => print(node))
     })
   }
 }

src/cli/commands/bootstrap/rm.js

@@ -3,6 +3,8 @@
 const debug = require('debug')
 const log = debug('cli:bootstrap')
 log.error = debug('cli:bootstrap:error')
+const print = require('../../utils').print
+
 module.exports = {
   command: 'rm [<peer>]',
 
@@ -24,7 +26,7 @@ module.exports = {
         throw err
       }
 
-      list.Peers.forEach((l) => console.log(l))
+      list.Peers.forEach((peer) => print(peer))
     })
   }
 }

src/cli/commands/commands.js

@@ -1,5 +1,5 @@
 'use strict'
-
+const print = require('../utils').print
 const path = require('path')
 const glob = require('glob').sync
 
@@ -23,6 +23,6 @@ module.exports = {
         .replace('.js', '')
     }).sort().map((cmd) => `ipfs ${cmd}`)
 
-    console.log(['ipfs'].concat(cmds).join('\n'))
+    print(['ipfs'].concat(cmds).join('\n'))
   }
 }