directory-shaker v0.4.0

Directory Shaker

Convert JS files (include ES6) structure into object, extract data

Installation

npm install directory-shaker

Usage

const path = require('path');
const getTreeObj = require('directory-shaker');

.........

const folder = path.resolve(__dirname, 'folder');

const { tree, parserName1, parserName2 } = getTreeObj(folder, {
 recursive: true,
 spreadIndex: true,
 pattern: /^.*\.js$/,
 filter: () => true,
}, { // parser }, { // parser } )

.........

Check test folder for more examples

Arguments

• path: string: path to the root folder to start with
• options: object: configuration options
• parser: object: parser to extract data separately

Options

• recursive: boolean: true deep object construction
• spreadIndex: boolean: true assign index props to the root or in 'index' node
• pattern: RegExp: /^.*\.js$/ file pattern to be included in the tree
• filter: function: filter files to be included in the tree

Parser

{
  name: 'paths',
  key: 'name',
  map: ({ name, page }, meta) => ({ name, page, meta}),
}

• name: string: name of the object to be returned
• key: string: key in the result object to assign result of the map function
• map: function: function to prepare object data to be returned

Map Function

• data: object: file default exported object
• meta: object: file meta data: 'name' and 'path'

Limitations

See 'esm' library documentation for the limitations