Giter Club home page Giter Club logo

dstruc's Introduction

dstruc

Build Status

Note on tests

The tests might fail on travis due to deepEqual matching the index on arrays; this might cause a missmatch with FS and the expected output. I will look into a better solution when possible.

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

dstruc's People

Contributors

transitorybliss avatar

Stargazers

 avatar  avatar

Watchers

 avatar

dstruc's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.