feat: integrate with jsipfs cli

License: MIT
Signed-off-by: achingbrain <[email protected]>

Author: achingbrain

cli.js

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = require('./src/cli')

core.js

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = require('./src/core')

src/cli/cp.js

@@ -1,22 +1,28 @@
 'use strict'
 
+const {
+  asBoolean
+} = require('./utils')
+
 module.exports = {
   command: 'cp <source> <dest>',
 
-  describe: 'Copy files between locations in the mfs.',
+  describe: 'Copy files between locations in the mfs',
 
   builder: {
     parents: {
       alias: 'p',
       type: 'boolean',
       default: false,
+      coerce: asBoolean,
       describe: 'Create any non-existent intermediate directories'
     },
     recursive: {
       alias: 'r',
       type: 'boolean',
       default: false,
-      describe: 'Remove directories recursively'
+      coerce: asBoolean,
+      describe: 'Copy directories recursively'
     }
   },
 

src/cli/index.js

@@ -0,0 +1,24 @@
+'use strict'
+
+const {
+  print
+} = require('./utils')
+
+const command = {
+  command: 'files <command>',
+
+  description: 'Operations over mfs files (ls, mkdir, rm, etc)',
+
+  builder (yargs) {
+    return yargs.commandDir('.')
+  },
+
+  handler (argv) {
+    print('Type `jsipfs files --help` for more instructions')
+  }
+}
+
+module.exports = (yargs) => {
+  return yargs
+    .command(command)
+}

src/cli/ls.js

@@ -1,19 +1,24 @@
 'use strict'
 
 const {
-  print
+  print,
+  asBoolean
 } = require('./utils')
+const {
+  FILE_SEPARATOR
+} = require('../core/utils')
 
 module.exports = {
-  command: 'ls <path>',
+  command: 'ls [path]',
 
-  describe: 'List directories in the local mutable namespace.',
+  describe: 'List mfs directories',
 
   builder: {
     long: {
       alias: 'l',
       type: 'boolean',
       default: false,
+      coerce: asBoolean,
       describe: 'Use long listing format.'
     }
   },
@@ -25,20 +30,50 @@ module.exports = {
       long
     } = argv
 
-    ipfs.mfs.ls(path, {
+    ipfs.mfs.ls(path || FILE_SEPARATOR, {
       long
     }, (error, files) => {
       if (error) {
         throw error
       }
 
-      files.forEach(link => {
-        if (long) {
-          return print(`${link.name} ${link.hash} ${link.size}`)
-        }
+      if (long) {
+        const table = []
+        const lengths = {}
+
+        files.forEach(link => {
+          const row = {
+            name: `${link.name}`,
+            hash: `${link.hash}`,
+            size: `${link.size}`
+          }
+
+          Object.keys(row).forEach(key => {
+            const value = row[key]
+
+            lengths[key] = lengths[key] > value.length ? lengths[key] : value.length
+          })
+
+          table.push(row)
+        })
+
+        table.forEach(row => {
+          let line = ''
+
+          Object.keys(row).forEach(key => {
+            const value = row[key]
+
+            line += value.padEnd(lengths[key] - value.length)
+            line += '\t'
+          })
+
+          print(line)
+        })
+
+        return
+      }
 
-        print(link.name)
-      })
+      files.forEach(link => print(link.name))
     })
   }
 }

src/cli/mkdir.js

@@ -1,19 +1,21 @@
 'use strict'
 
 const {
-  print
+  print,
+  asBoolean
 } = require('./utils')
 
 module.exports = {
   command: 'mkdir <path>',
 
-  describe: 'Make directories.',
+  describe: 'Make mfs directories',
 
   builder: {
     parents: {
       alias: 'p',
       type: 'boolean',
       default: false,
+      coerce: asBoolean,
       describe: 'No error if existing, make parent directories as needed.'
     },
     cidVersion: {
@@ -28,6 +30,7 @@ module.exports = {
     flush: {
       alias: 'f',
       type: 'boolean',
+      coerce: asBoolean,
       describe: 'Weird undocumented option'
     }
   },

src/cli/mv.js

@@ -1,21 +1,27 @@
 'use strict'
 
+const {
+  asBoolean
+} = require('./utils')
+
 module.exports = {
   command: 'mv <source> <dest>',
 
-  describe: 'Move files around. Just like traditional unix mv',
+  describe: 'Move mfs files around',
 
   builder: {
     parents: {
       alias: 'p',
       type: 'boolean',
       default: false,
+      coerce: asBoolean,
       describe: 'Create any non-existent intermediate directories'
     },
     recursive: {
       alias: 'r',
       type: 'boolean',
       default: false,
+      coerce: asBoolean,
       describe: 'Remove directories recursively'
     }
   },

src/cli/read.js

@@ -0,0 +1,57 @@
+'use strict'
+
+const pull = require('pull-stream/pull')
+const through = require('pull-stream/throughs/through')
+const collect = require('pull-stream/sinks/collect')
+const waterfall = require('async/waterfall')
+const {
+  print
+} = require('./utils')
+
+module.exports = {
+  command: 'read <path>',
+
+  describe: 'Read an mfs file',
+
+  builder: {
+    offset: {
+      alias: 'o',
+      type: 'number',
+      describe: 'Start writing at this offset'
+    },
+    length: {
+      alias: 'l',
+      type: 'number',
+      describe: 'Write only this number of bytes'
+    }
+  },
+
+  handler (argv) {
+    let {
+      path,
+      ipfs,
+      offset,
+      length
+    } = argv
+
+    waterfall([
+      (cb) => ipfs.mfs.readPullStream(path, {
+        offset,
+        length
+      }, cb),
+      (stream, cb) => {
+        pull(
+          stream,
+          through(buffer => {
+            print(buffer)
+          }),
+          collect(cb)
+        )
+      }
+    ], (error) => {
+      if (error) {
+        throw error
+      }
+    })
+  }
+}

src/cli/rm.js

@@ -1,15 +1,20 @@
 'use strict'
 
+const {
+  asBoolean
+} = require('./utils')
+
 module.exports = {
   command: 'rm <path>',
 
-  describe: 'Remove a file or directory',
+  describe: 'Remove an mfs file or directory',
 
   builder: {
     recursive: {
       alias: 'r',
       type: 'boolean',
       default: false,
+      coerce: asBoolean,
       describe: 'Remove directories recursively'
     }
   },

src/cli/utils.js

@@ -15,7 +15,20 @@ const print = (msg = '', newline = true) => {
   process.stdout.write(msg)
 }
 
+const asBoolean = (value) => {
+  if (value === false || value === true) {
+    return value
+  }
+
+  if (value === undefined) {
+    return true
+  }
+
+  return false
+}
+
 module.exports = {
   disablePrinting,
-  print
+  print,
+  asBoolean
 }