@oresoftware/waldo

Semver-oriented TypeScript library skeleton.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
15Sep 4, 2018May 8, 2018Minified + gzip package size for @oresoftware/waldo in KB

Readme

@oresoftware/waldo

GNU/BSD find kills me sometimes, so I wrote this.

install:


# for command line tools
npm install -g waldo

# for library usage
npm install waldo --save

At the command line:

Basic usage
waldo --path="."  ### lists all matching files (no dirs)

Note that if you omit the --path arg, it defaults to $PWD/.

waldo --path="." --dirs  ### lists just dirs, -d for short
waldo --path="." --dirs --files  ### lists files and dirs, -f and -d for short
Using matching
waldo --path="." -n /node_modules/   # don't match any path that has /node_modules/ in it

waldo --path="." -n ^/node_modules/   # don't match any path that starts with /node_modules/ 

waldo --path="." -n '\.js$'   # don't match any path ends that with '.js'

waldo --path="." -m '\.js$'   #  match only paths that end that with '.js'

Library Usage


import {WaldoSearch} from '@oresoftware/waldo';

new WaldoSearch({
  
  path,  // the path you which to search
  matchesAnyOf,  // array of strings or RegExp
  matchesNoneOf, // array of strings or RegExp
  dirs,   // list dirs
  files   // list files (true by default)
  
})
.search((err, results) => {

    // results is your array of strings
});

to use with ES6 Promises

=> Use the searchp() method
new WaldoSearch({...}).searchp().then(results => {

    // results is your array of strings
});

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.