File Explorer

1'use strict'2 3const test = require('tape')4const concat = require('concat-stream')5const fs = require('fs')6const helpMe = require('./')7 8test('throws if no directory is passed', function (t) {9  try {10    helpMe()11    t.fail()12  } catch (err) {13    t.equal(err.message, 'missing dir')14  }15  t.end()16})17 18test('throws if a normal file is passed', function (t) {19  try {20    helpMe({21      dir: __filename22    })23    t.fail()24  } catch (err) {25    t.equal(err.message, `${__filename} is not a directory`)26  }27  t.end()28})29 30test('throws if the directory cannot be accessed', function (t) {31  try {32    helpMe({33      dir: './foo'34    })35    t.fail()36  } catch (err) {37    t.equal(err.message, './foo is not a directory')38  }39  t.end()40})41 42test('show a generic help.txt from a folder to a stream', function (t) {43  t.plan(2)44 45  helpMe({46    dir: 'fixture/basic'47  }).createStream()48    .pipe(concat(function (data) {49      fs.readFile('fixture/basic/help.txt', function (err, expected) {50        t.error(err)51        t.equal(data.toString(), expected.toString())52      })53    }))54})55 56test('custom help command with an array', function (t) {57  t.plan(2)58 59  helpMe({60    dir: 'fixture/basic'61  }).createStream(['hello'])62    .pipe(concat(function (data) {63      fs.readFile('fixture/basic/hello.txt', function (err, expected) {64        t.error(err)65        t.equal(data.toString(), expected.toString())66      })67    }))68})69 70test('custom help command without an ext', function (t) {71  t.plan(2)72 73  helpMe({74    dir: 'fixture/no-ext',75    ext: ''76  }).createStream(['hello'])77    .pipe(concat(function (data) {78      fs.readFile('fixture/no-ext/hello', function (err, expected) {79        t.error(err)80        t.equal(data.toString(), expected.toString())81      })82    }))83})84 85test('custom help command with a string', function (t) {86  t.plan(2)87 88  helpMe({89    dir: 'fixture/basic'90  }).createStream('hello')91    .pipe(concat(function (data) {92      fs.readFile('fixture/basic/hello.txt', function (err, expected) {93        t.error(err)94        t.equal(data.toString(), expected.toString())95      })96    }))97})98 99test('missing help file', function (t) {100  t.plan(1)101 102  helpMe({103    dir: 'fixture/basic'104  }).createStream('abcde')105    .on('error', function (err) {106      t.equal(err.message, 'no such help file')107    })108    .resume()109})110 111test('custom help command with an array', function (t) {112  const helper = helpMe({113    dir: 'fixture/shortnames'114  })115 116  t.test('abbreviates two words in one', function (t) {117    t.plan(2)118 119    helper120      .createStream(['world'])121      .pipe(concat(function (data) {122        fs.readFile('fixture/shortnames/hello world.txt', function (err, expected) {123          t.error(err)124          t.equal(data.toString(), expected.toString())125        })126      }))127  })128 129  t.test('abbreviates three words in two', function (t) {130    t.plan(2)131 132    helper133      .createStream(['abcde', 'fghi'])134      .pipe(concat(function (data) {135        fs.readFile('fixture/shortnames/abcde fghi lmno.txt', function (err, expected) {136          t.error(err)137          t.equal(data.toString(), expected.toString())138        })139      }))140  })141 142  t.test('abbreviates a word', function (t) {143    t.plan(2)144 145    helper146      .createStream(['abc', 'fg'])147      .pipe(concat(function (data) {148        fs.readFile('fixture/shortnames/abcde fghi lmno.txt', function (err, expected) {149          t.error(err)150          t.equal(data.toString(), expected.toString())151        })152      }))153  })154 155  t.test('abbreviates a word using strings', function (t) {156    t.plan(2)157 158    helper159      .createStream('abc fg')160      .pipe(concat(function (data) {161        fs.readFile('fixture/shortnames/abcde fghi lmno.txt', function (err, expected) {162          t.error(err)163          t.equal(data.toString(), expected.toString())164        })165      }))166  })167 168  t.test('print a disambiguation', function (t) {169    t.plan(1)170 171    const expected = '' +172      'There are 2 help pages that matches the given request, please disambiguate:\n' +173      '  * abcde fghi lmno\n' +174      '  * abcde hello\n'175 176    helper177      .createStream(['abc'])178      .pipe(concat({ encoding: 'string' }, function (data) {179        t.equal(data, expected)180      }))181  })182 183  t.test('choose exact match over partial', function (t) {184    t.plan(1)185 186    helpMe({187      dir: 'fixture/sameprefix'188    }).createStream(['hello'])189      .pipe(concat({ encoding: 'string' }, function (data) {190        t.equal(data, 'hello')191      }))192  })193})194 195test('support for help files organized in folders', function (t) {196  const helper = helpMe({197    dir: 'fixture/dir'198  })199 200  t.test('passing an array', function (t) {201    t.plan(2)202 203    helper204      .createStream(['a', 'b'])205      .pipe(concat(function (data) {206        fs.readFile('fixture/dir/a/b.txt', function (err, expected) {207          t.error(err)208          t.equal(data.toString(), expected.toString())209        })210      }))211  })212 213  t.test('passing a string', function (t) {214    t.plan(2)215 216    helper217      .createStream('a b')218      .pipe(concat(function (data) {219        fs.readFile('fixture/dir/a/b.txt', function (err, expected) {220          t.error(err)221          t.equal(data.toString(), expected.toString())222        })223      }))224  })225})226