Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    dstrucpublic

    dstruc

    Build Status

    Quickly get directory structure and files from a specified path in node, with support for recursive operations.

    Installation

    $ npm install dstruc --save
    

    Usage

    var dstruc = require('dstruc');
    var structure = dstruc.sync('/path/to/dir');
    console.log(structure); 
    /* 
    { files: [ 'level.one.file.txt' ],
      dirs:
       { another_level_two: { files: [Object], dirs: {} },
         level_two: { files: [Object], dirs: {} } } }
    */
     
    var structureWithExtensions = dstruc.sync('/another/path/to/dir', { extensionAsKey: true });
    console.log(structureWithExtensions);
    /*{ files: { txt: [ 'one.file.txt', 'two.file.txt' ] }, dirs: {} }*/

    Options

    recursive: Will traverse directories until it reaches the bottom. If set to false, directories of the top level will instead be put in an array.

    extensionAsKey: Will put the files in an object with their extension as the key instead of an array.

    Testing

    $ npm test
    

    Todo

    • Add async version

    License

    BSD

    install

    npm i dstruc

    Downloadsweekly downloads

    7

    version

    0.1.2

    license

    BSD-2-Clause

    repository

    githubgithub

    last publish

    collaborators

    • avatar