Skip to content

tiaanduplessis/read-dir-recur

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

read-dir-recur

package version package downloads standard-readme compliant package license make a pull request

Recursively read directories

Table of Contents

Install

This project uses node and npm.

$ npm install read-dir-recur
$ # OR
$ yarn add read-dir-recur

Usage

When reading dir with this structure:

bar/
├── baaa
├── baz.js
├── ping.js
└── pong.md
const readDirRecur = require('read-dir-recur')

console.log(readDirRecur({ readFile: false, pattern: '*.js', ignore: ['baaa'], base: ROOT_DIR }))
//  { bar:
//        [ { base: 'bar', name: 'baz.js', ext: '.js', size: 0 },
//          { base: 'bar', name: 'ping.js', ext: '.js', size: 0 } ] }

Uses micromatch for pattern and ignore of files.

Contribute

  1. Fork it and create your feature branch: git checkout -b my-new-feature
  2. Commit your changes: git commit -am "Add some feature"
  3. Push to the branch: git push origin my-new-feature
  4. Submit a pull request

License

MIT