keyfob v2.0.1

keyfob

this is a simple little module that allows you to run a function on a tree of files, and get an object as a result.

for example, given the following directory structure:

files/one.txt
files/deeper/two.txt
files/another.txt

and this code:

const Keyfob = require('keyfob');
const results = Keyfob.load({ path: 'files' });

you would get this result:

{
  one: 'contents of one.txt',
  deeper: {
    two: 'contents of two.txt'
  },
  another: 'contents of another.txt'
}

when using the flat option (const results = Keyfob.load({ path: 'files', flat: true })) you would get this result:

{
  one: 'contents of one.txt',
  'deeper/two': 'contents of two.txt',
  another: 'contents of another.txt'
}

Options

root: the root of the directory tree you wish to load. required

flat: instead of creating a nested object, flatten keys into slash separated names. defaults to false

patterns: an array of minimatch patterns that represent files that should be included. defaults to ['*'] (all files)

fn: the function to run on each file. the default is:

function (path) {
  return fs.readFileSync(path, 'utf8');
}

this will load the files as plain utf8 text. you can pass any method that accepts a file path and returns a result. if you'd like to read a tree of javascript or json, set fn to require.