start refactoring the cli using yargs. Closes #331

Author: dignifiedquire

package.json

@@ -67,8 +67,8 @@
     "fs-blob-store": "^5.2.1",
     "glob": "^7.0.3",
     "hapi": "^13.4.1",
-    "ipfs-bitswap": "^0.6.0",
     "ipfs-api": "^6.0.1",
+    "ipfs-bitswap": "^0.6.0",
     "ipfs-block": "^0.3.0",
     "ipfs-block-service": "^0.4.0",
     "ipfs-merkle-dag": "^0.6.0",
@@ -83,21 +83,24 @@
     "lodash.get": "^4.3.0",
     "lodash.set": "^4.2.0",
     "mafmt": "^2.1.1",
-    "multihashes": "^0.2.2",
     "multiaddr": "^2.0.2",
+    "multihashes": "^0.2.2",
     "path-exists": "^3.0.0",
     "peer-book": "^0.3.0",
     "peer-id": "^0.7.0",
     "peer-info": "^0.7.0",
     "promisify-es6": "^1.0.1",
+    "read-pkg-up": "^1.0.1",
     "readable-stream": "1.1.13",
     "ronin": "^0.3.11",
     "run-parallel": "^1.1.6",
     "run-parallel-limit": "^1.0.3",
     "run-series": "^1.1.4",
     "run-waterfall": "^1.1.3",
     "temp": "^0.8.3",
-    "through2": "^2.0.1"
+    "through2": "^2.0.1",
+    "update-notifier": "^1.0.2",
+    "yargs": "^4.8.1"
   },
   "contributors": [
     "Andrew de Andrade <[email protected]>",

src/cli/bin.js

@@ -2,12 +2,18 @@
 
 'use strict'
 
-const ronin = require('ronin')
+const yargs = require('yargs')
+const updateNotifier = require('update-notifier')
+const readPkgUp = require('read-pkg-up')
 
-const cli = ronin(__dirname)
+const pkg = readPkgUp.sync().pkg
+updateNotifier({
+  pkg,
+  updateCheckInterval: 1000 * 60 * 60 * 24 * 7 // 1 week
+}).notify()
 
-cli.run()
-
-// cli.autoupdate(function () {
-//   cli.run()
-// })
+require('yargs')
+  .commandDir('commands')
+  .demand(1)
+  .help()
+  .argv

src/cli/commands/bitswap.js

@@ -0,0 +1,15 @@
+'use strict'
+
+module.exports = {
+  command: 'bitswap',
+
+  description: 'A set of commands to manipulate the bitswap agent.',
+
+  builder (yargs) {
+    return yargs
+      .commandDir('bitswap')
+  },
+
+  handler (argv) {
+  }
+}

src/cli/commands/bitswap/stat.js

@@ -1,15 +1,16 @@
 'use strict'
 
-const Command = require('ronin').Command
 const utils = require('../../utils')
 
-module.exports = Command.extend({
-  desc: 'Show some diagnostic information on the bitswap agent.',
+module.exports = {
+  command: 'stat',
 
-  options: {
+  describe: 'Show some diagnostic information on the bitswap agent.',
+
+  builder: {
   },
 
-  run: () => {
+  handler: () => {
     utils.getIPFS((err, ipfs) => {
       if (err) {
         throw err
@@ -35,4 +36,4 @@ bitswap status
       })
     })
   }
-})
+}

src/cli/commands/bitswap/unwant.js

@@ -1,18 +1,19 @@
 'use strict'
 
-const Command = require('ronin').Command
 const utils = require('../../utils')
 
-module.exports = Command.extend({
-  desc: 'Remove a given block from your wantlist.',
+module.exports = {
+  command: 'unwant',
 
-  options: {
+  describe: 'Remove a given block from your wantlist.',
+
+  builder: {
     key: {
       required: true
     }
   },
 
-  run: (key) => {
+  handler: (key) => {
     utils.getIPFS((err, ipfs) => {
       if (err) {
         throw err
@@ -21,4 +22,4 @@ module.exports = Command.extend({
       throw new Error('Not implemented yet')
     })
   }
-})
+}

src/cli/commands/bitswap/wantlist.js

@@ -1,15 +1,16 @@
 'use strict'
 
-const Command = require('ronin').Command
 const utils = require('../../utils')
 
-module.exports = Command.extend({
-  desc: 'Print out all blocks currently on the bitswap wantlist for the local peer.',
+module.exports = {
+  command: 'wantlist',
 
-  options: {
+  describe: 'Print out all blocks currently on the bitswap wantlist for the local peer.',
+
+  builder: {
   },
 
-  run: () => {
+  handler: () => {
     utils.getIPFS((err, ipfs) => {
       if (err) {
         throw err
@@ -23,4 +24,4 @@ module.exports = Command.extend({
       })
     })
   }
-})
+}

src/cli/commands/block.js

@@ -0,0 +1,15 @@
+'use strict'
+
+module.exports = {
+  command: 'block',
+
+  description: 'Manipulate raw IPFS blocks.',
+
+  builder (yargs) {
+    return yargs
+      .commandDir('block')
+  },
+
+  handler (argv) {
+  }
+}

src/cli/commands/block/get.js

@@ -1,18 +1,19 @@
 'use strict'
 
-const Command = require('ronin').Command
 const utils = require('../../utils')
 const bs58 = require('bs58')
 const debug = require('debug')
 const log = debug('cli:block')
 log.error = debug('cli:block:error')
 
-module.exports = Command.extend({
-  desc: 'Get a raw IPFS block',
+module.exports = {
+  command: 'get',
 
-  options: {},
+  describe: 'Get a raw IPFS block',
 
-  run: (key) => {
+  builder: {},
+
+  handler: (key) => {
     if (!key) {
       throw new Error("Argument 'key' is required")
     }
@@ -40,4 +41,4 @@ module.exports = Command.extend({
       })
     })
   }
-})
+}

src/cli/commands/block/put.js

@@ -1,6 +1,5 @@
 'use strict'
 
-const Command = require('ronin').Command
 const utils = require('../../utils')
 const bs58 = require('bs58')
 const bl = require('bl')
@@ -38,12 +37,14 @@ function addBlock (buf) {
   })
 }
 
-module.exports = Command.extend({
-  desc: 'Stores input as an IPFS block',
+module.exports = {
+  command: 'put',
 
-  options: {},
+  describe: 'Stores input as an IPFS block',
 
-  run: (filePath) => {
+  builder: {},
+
+  handler: (filePath) => {
     if (filePath) {
       return addBlock(fs.readFileSync(filePath))
     }
@@ -56,4 +57,4 @@ module.exports = Command.extend({
       addBlock(input)
     }))
   }
-})
+}

src/cli/commands/block/rm.js

@@ -1,18 +1,19 @@
 'use strict'
 
-const Command = require('ronin').Command
 const utils = require('../../utils')
 const bs58 = require('bs58')
 const debug = require('debug')
 const log = debug('cli:block')
 log.error = debug('cli:block:error')
 
-module.exports = Command.extend({
-  desc: 'Remove a raw IPFS block',
+module.exports = {
+  command: 'rm',
 
-  options: {},
+  describe: 'Remove a raw IPFS block',
 
-  run: (key) => {
+  builder: {},
+
+  handler: (key) => {
     if (!key) {
       throw new Error("Argument 'key' is required")
     }
@@ -38,4 +39,4 @@ module.exports = Command.extend({
       })
     })
   }
-})
+}

src/cli/commands/block/stat.js

@@ -1,18 +1,19 @@
 'use strict'
 
-const Command = require('ronin').Command
 const utils = require('../../utils')
 const bs58 = require('bs58')
 const debug = require('debug')
 const log = debug('cli:block')
 log.error = debug('cli:block:error')
 
-module.exports = Command.extend({
-  desc: 'Print information of a raw IPFS block',
+module.exports = {
+  command: 'stat',
 
-  options: {},
+  describe: 'Print information of a raw IPFS block',
 
-  run: (key) => {
+  builder: {},
+
+  handler: (key) => {
     if (!key) {
       throw new Error("Argument 'key' is required")
     }
@@ -41,4 +42,4 @@ module.exports = Command.extend({
       })
     })
   }
-})
+}

src/cli/commands/bootstrap.js

@@ -0,0 +1,15 @@
+'use strict'
+
+module.exports = {
+  command: 'bootstrap',
+
+  description: 'Show or edit the list of bootstrap peers.',
+
+  builder (yargs) {
+    return yargs
+      .commandDir('bootstrap')
+  },
+
+  handler (argv) {
+  }
+}

src/cli/commands/bootstrap/add.js

@@ -1,17 +1,18 @@
 'use strict'
 
-const Command = require('ronin').Command
 const debug = require('debug')
 const log = debug('cli:bootstrap')
 const utils = require('../../utils')
 log.error = debug('cli:bootstrap:error')
 
-module.exports = Command.extend({
-  desc: 'Add peers to the bootstrap list',
+module.exports = {
+  command: 'add',
 
-  options: {},
+  describe: 'Add peers to the bootstrap list',
 
-  run: (multiaddr) => {
+  builder: {},
+
+  handler: (multiaddr) => {
     utils.getIPFS((err, ipfs) => {
       if (err) {
         throw err
@@ -23,4 +24,4 @@ module.exports = Command.extend({
       })
     })
   }
-})
+}

src/cli/commands/bootstrap/list.js

@@ -1,17 +1,18 @@
 'use strict'
 
-const Command = require('ronin').Command
 const utils = require('../../utils')
 const debug = require('debug')
 const log = debug('cli:bootstrap')
 log.error = debug('cli:bootstrap:error')
 
-module.exports = Command.extend({
-  desc: 'Show peers in the bootstrap list',
+module.exports = {
+  command: 'list',
 
-  options: {},
+  describe: 'Show peers in the bootstrap list',
 
-  run: () => {
+  builder: {},
+
+  handler: () => {
     utils.getIPFS((err, ipfs) => {
       if (err) {
         throw err
@@ -26,4 +27,4 @@ module.exports = Command.extend({
       })
     })
   }
-})
+}