fix: Add ipfs path to cli help

Author: vasco-santos

src/cli/bin.js

@@ -29,6 +29,7 @@ const cli = yargs
     default: ''
   })
   .commandDir('commands')
+  .epilog(utils.ipfsPathHelp)
   .demandCommand(1)
   .fail((msg, err, yargs) => {
     if (err) {

src/cli/commands/daemon.js

@@ -11,15 +11,17 @@ module.exports = {
 
   describe: 'Start a long-running daemon process',
 
-  builder: {
-    'enable-sharding-experiment': {
-      type: 'boolean',
-      default: false
-    },
-    'enable-pubsub-experiment': {
-      type: 'boolean',
-      default: false
-    }
+  builder (yargs) {
+    return yargs
+      .epilog(utils.ipfsPathHelp)
+      .option('enable-sharding-experiment', {
+        type: 'boolean',
+        default: false
+      })
+      .option('enable-pubsub-experiment', {
+        type: 'boolean',
+        default: false
+      })
   },
 
   handler (argv) {

src/cli/commands/init.js

@@ -5,19 +5,14 @@ const IPFS = require('../../core')
 const utils = require('../utils')
 const print = utils.print
 
-const ipfsPathHelp = 'ipfs uses a repository in the local file system. By default, the repo is ' +
-  'located at ~/.ipfs.\nTo change the repo location, set the $IPFS_PATH environment variable:\n\n' +
-  '\texport IPFS_PATH=/path/to/ipfsrepo\n'
-
 module.exports = {
   command: 'init',
 
   describe: 'Initialize a local IPFS node',
 
   builder (yargs) {
-    print(ipfsPathHelp)
-
     return yargs
+      .epilog(utils.ipfsPathHelp)
       .option('bits', {
         type: 'number',
         alias: 'b',

src/cli/utils.js

@@ -111,3 +111,7 @@ exports.rightpad = (val, n) => {
   }
   return result
 }
+
+exports.ipfsPathHelp = 'ipfs uses a repository in the local file system. By default, the repo is ' +
+  'located at ~/.jsipfs. To change the repo location, set the $IPFS_PATH environment variable:\n\n' +
+  'export IPFS_PATH=/path/to/ipfsrepo\n'

test/cli/daemon.js

@@ -120,4 +120,13 @@ describe('daemon', () => {
       done()
     })
   })
+
+  it('should present ipfs path help when option help is received', function (done) {
+    this.timeout(100 * 1000)
+
+    ipfs('daemon --help').then((res) => {
+      expect(res).to.have.string('export IPFS_PATH=/path/to/ipfsrepo')
+      done()
+    })
+  })
 })

test/cli/init.js

@@ -66,4 +66,13 @@ describe('init', function () {
       expect(repoExistsSync('version')).to.equal(true)
     })
   })
+
+  it('should present ipfs path help when option help is received', function (done) {
+    this.timeout(100 * 1000)
+
+    ipfs('init --help').then((res) => {
+      expect(res).to.have.string('export IPFS_PATH=/path/to/ipfsrepo')
+      done()
+    })
+  })
 })