{"_id":"scandirectory","_rev":"5-543bc3aea2f828a93bf1d91aad9ce060","name":"scandirectory","description":"Scan a directory recursively with a lot of control and power","dist-tags":{"latest":"3.0.1"},"versions":{"2.5.0":{"name":"scandirectory","version":"2.5.0","description":"Scan a directory recursively with a lot of control and power","homepage":"https://github.com/bevry/scandirectory","license":{"type":"MIT"},"badges":{"travis":true,"npm":true,"npmdownloads":true,"david":true,"daviddev":true,"gratipay":"bevry","flattr":"344188/balupton-on-Flattr","paypal":"QB8GQPZAH84N6","bitcoin":"https://coinbase.com/checkouts/9ef59f5479eec1d97d63382c9ebcb93a","wishlist":"http://amzn.com/w/2F8TXKSNAFG4V"},"keywords":["path","fs","scandir","scandirectory","scantree","scanlist","recursive","tree"],"author":{"name":"2011+ Benjamin Lupton","email":"[email protected]","url":"http://balupton.com"},"maintainers":[{"name":"balupton","email":"[email protected]"}],"contributors":[{"name":"Benjamin Lupton","email":"[email protected]","url":"https://github.com/balupton"},{"name":"sfrdmn","url":"https://github.com/sfrdmn"}],"bugs":{"url":"https://github.com/bevry/scandirectory/issues"},"repository":{"type":"git","url":"http://github.com/bevry/scandirectory.git"},"engines":{"node":">=0.4"},"dependencies":{"ignorefs":"^1.0.0","safefs":"^3.1.2","taskgroup":"^4.0.5"},"devDependencies":{"coffee-script":"~1.8.0","joe":"~1.5.0","joe-reporter-console":"~1.2.1","chai":"~1.10.0","projectz":"~0.3.17"},"directories":{"lib":"./out/lib"},"scripts":{"test":"node ./out/test/scandirectory-test.js"},"main":"./out/lib/scandirectory","cakeConfiguration":{"COFFEE_SRC_PATH":"src"},"gitHead":"c28fb0baaf257962a9caa7d541fb963a015dac4a","_id":"[email protected]","_shasum":"6ce03f54a090b668e3cbedbf20edf9e310593e72","_from":".","_npmVersion":"2.1.11","_nodeVersion":"0.10.33","_npmUser":{"name":"balupton","email":"[email protected]"},"dist":{"shasum":"6ce03f54a090b668e3cbedbf20edf9e310593e72","tarball":"https://registry.npmjs.org/scandirectory/-/scandirectory-2.5.0.tgz"}},"3.0.0":{"name":"scandirectory","version":"3.0.0","description":"Scan a directory recursively with a lot of control and power","homepage":"https://github.com/bevry/scandirectory","license":"MIT","keywords":["path","fs","scandir","scandirectory","scantree","scanlist","recursive","tree"],"badges":{"list":["travisci","npmversion","npmdownloads","daviddm","daviddmdev","---","slackin","patreon","gratipay","flattr","paypal","bitcoin","wishlist"],"config":{"patreonUsername":"bevry","gratipayUsername":"bevry","flattrUsername":"balupton","paypalURL":"https://bevry.me/paypal","bitcoinURL":"https://bevry.me/bitcoin","wishlistURL":"https://bevry.me/wishlist","slackinURL":"https://slack.bevry.me"}},"author":{"name":"2011+ Benjamin Lupton","email":"[email protected]","url":"http://balupton.com"},"maintainers":[{"name":"balupton","email":"[email protected]"}],"contributors":[{"name":"Benjamin Lupton","email":"[email protected]","url":"http://balupton.com"},{"name":"Sean Fridman","email":"[email protected]","url":"http://seanfridman.com"}],"bugs":{"url":"https://github.com/bevry/scandirectory/issues"},"repository":{"type":"git","url":"git+https://github.com/bevry/scandirectory.git"},"engines":{"node":">=0.8"},"editions":[{"description":"Source + ESNext + Require","entry":"index.js","directory":"source","syntaxes":["javascript","esnext","require","const","let"]},{"description":"Babel Compiled + ES2015 + Require","entry":"index.js","directory":"es2015","syntaxes":["javascript","es2015","require"]}],"main":"index.js","scripts":{"setup":"npm install","clean":"rm -Rf ./docs ./es2015","compile":"npm run compile:es2015","compile:es2015":"babel ./source --out-dir ./es2015 --presets es2015","meta":"npm run meta:projectz","meta:projectz":"projectz compile","prepare":"npm run compile && npm run test && npm run meta","release":"npm run prepare && npm run release:publish && npm run release:tag && npm run release:push","release:publish":"npm publish","release:tag":"git tag v$npm_package_version -a","release:push":"git push origin master && git push origin --tags","pretest":"npm run test:eslint","test:eslint":"eslint ./source","test":"node --harmony ./test.js"},"dependencies":{"editions":"^1.3.1","ignorefs":"^1.1.1","readdir-cluster":"^1.1.0"},"devDependencies":{"assert-helpers":"^4.4.0","babel-cli":"^6.16.0","babel-preset-es2015":"^6.16.0","eslint":"^2.3.0","joe":"^1.8.0","joe-reporter-console":"^1.2.1","projectz":"^1.3.0"},"gitHead":"09c7cae1971a9cf2340f5261718ede1663670b57","_id":"[email protected]","_shasum":"c75a1b33b7af775a5820bc8690339ad3a2210e54","_from":".","_npmVersion":"3.10.8","_nodeVersion":"6.9.0","_npmUser":{"name":"balupton","email":"[email protected]"},"dist":{"shasum":"c75a1b33b7af775a5820bc8690339ad3a2210e54","tarball":"https://registry.npmjs.org/scandirectory/-/scandirectory-3.0.0.tgz"},"_npmOperationalInternal":{"host":"packages-18-east.internal.npmjs.com","tmp":"tmp/scandirectory-3.0.0.tgz_1476949555496_0.008781386772170663"},"directories":{}},"3.0.1":{"name":"scandirectory","version":"3.0.1","description":"Scan a directory recursively with a lot of control and power","homepage":"https://github.com/bevry/scandirectory","license":"MIT","keywords":["path","fs","scandir","scandirectory","scantree","scanlist","recursive","tree"],"badges":{"list":["travisci","npmversion","npmdownloads","daviddm","daviddmdev","---","slackin","patreon","gratipay","flattr","paypal","bitcoin","wishlist"],"config":{"patreonUsername":"bevry","gratipayUsername":"bevry","flattrUsername":"balupton","paypalURL":"https://bevry.me/paypal","bitcoinURL":"https://bevry.me/bitcoin","wishlistURL":"https://bevry.me/wishlist","slackinURL":"https://slack.bevry.me"}},"author":{"name":"2011+ Benjamin Lupton","email":"[email protected]","url":"http://balupton.com"},"maintainers":[{"name":"balupton","email":"[email protected]"}],"contributors":[{"name":"Benjamin Lupton","email":"[email protected]","url":"http://balupton.com"},{"name":"Sean Fridman","email":"[email protected]","url":"http://seanfridman.com"}],"bugs":{"url":"https://github.com/bevry/scandirectory/issues"},"repository":{"type":"git","url":"git+https://github.com/bevry/scandirectory.git"},"engines":{"node":">=0.8"},"editions":[{"description":"Source + ESNext + Require","entry":"index.js","directory":"source","syntaxes":["javascript","esnext","require","const","let"]},{"description":"Babel Compiled + ES2015 + Require","entry":"index.js","directory":"es2015","syntaxes":["javascript","es2015","require"]}],"main":"index.js","scripts":{"setup":"npm install","clean":"rm -Rf ./docs ./es2015","compile":"npm run compile:es2015","compile:es2015":"babel ./source --out-dir ./es2015 --presets es2015","meta":"npm run meta:projectz","meta:projectz":"projectz compile","prepare":"npm run compile && npm run test && npm run meta","release":"npm run prepare && npm run release:publish && npm run release:tag && npm run release:push","release:publish":"npm publish","release:tag":"git tag v$npm_package_version -a","release:push":"git push origin master && git push origin --tags","pretest":"npm run test:eslint","test:eslint":"eslint ./source","test":"node --harmony ./test.js"},"dependencies":{"editions":"^1.3.1","ignorefs":"^1.1.1","readdir-cluster":"^1.1.0"},"devDependencies":{"assert-helpers":"^4.4.0","babel-cli":"^6.16.0","babel-preset-es2015":"^6.16.0","eslint":"^2.3.0","joe":"^1.8.0","joe-reporter-console":"^1.2.1","projectz":"^1.3.0"},"gitHead":"390bef62bf1e9c87bab96d2f1b51298b5dcb960d","_id":"[email protected]","_shasum":"25dd201427c33cce4f8f40b2f37f2d03d07857ba","_from":".","_npmVersion":"3.10.8","_nodeVersion":"6.9.0","_npmUser":{"name":"balupton","email":"[email protected]"},"dist":{"shasum":"25dd201427c33cce4f8f40b2f37f2d03d07857ba","tarball":"https://registry.npmjs.org/scandirectory/-/scandirectory-3.0.1.tgz"},"_npmOperationalInternal":{"host":"packages-18-east.internal.npmjs.com","tmp":"tmp/scandirectory-3.0.1.tgz_1476949695609_0.6489486154168844"},"directories":{}}},"readme":"<!-- TITLE/ -->\n\n<h1>scandirectory</h1>\n\n<!-- /TITLE -->\n\n\n<!-- BADGES/ -->\n\n<span class=\"badge-travisci\"><a href=\"http://travis-ci.org/bevry/scandirectory\" title=\"Check this project's build status on TravisCI\"><img src=\"https://img.shields.io/travis/bevry/scandirectory/master.svg\" alt=\"Travis CI Build Status\" /></a></span>\n<span class=\"badge-npmversion\"><a href=\"https://npmjs.org/package/scandirectory\" title=\"View this project on NPM\"><img src=\"https://img.shields.io/npm/v/scandirectory.svg\" alt=\"NPM version\" /></a></span>\n<span class=\"badge-npmdownloads\"><a href=\"https://npmjs.org/package/scandirectory\" title=\"View this project on NPM\"><img src=\"https://img.shields.io/npm/dm/scandirectory.svg\" alt=\"NPM downloads\" /></a></span>\n<span class=\"badge-daviddm\"><a href=\"https://david-dm.org/bevry/scandirectory\" title=\"View the status of this project's dependencies on DavidDM\"><img src=\"https://img.shields.io/david/bevry/scandirectory.svg\" alt=\"Dependency Status\" /></a></span>\n<span class=\"badge-daviddmdev\"><a href=\"https://david-dm.org/bevry/scandirectory#info=devDependencies\" title=\"View the status of this project's development dependencies on DavidDM\"><img src=\"https://img.shields.io/david/dev/bevry/scandirectory.svg\" alt=\"Dev Dependency Status\" /></a></span>\n<br class=\"badge-separator\" />\n<span class=\"badge-slackin\"><a href=\"https://slack.bevry.me\" title=\"Join this project's slack community\"><img src=\"https://slack.bevry.me/badge.svg\" alt=\"Slack community badge\" /></a></span>\n<span class=\"badge-patreon\"><a href=\"http://patreon.com/bevry\" title=\"Donate to this project using Patreon\"><img src=\"https://img.shields.io/badge/patreon-donate-yellow.svg\" alt=\"Patreon donate button\" /></a></span>\n<span class=\"badge-gratipay\"><a href=\"https://www.gratipay.com/bevry\" title=\"Donate weekly to this project using Gratipay\"><img src=\"https://img.shields.io/badge/gratipay-donate-yellow.svg\" alt=\"Gratipay donate button\" /></a></span>\n<span class=\"badge-flattr\"><a href=\"https://flattr.com/profile/balupton\" title=\"Donate to this project using Flattr\"><img src=\"https://img.shields.io/badge/flattr-donate-yellow.svg\" alt=\"Flattr donate button\" /></a></span>\n<span class=\"badge-paypal\"><a href=\"https://bevry.me/paypal\" title=\"Donate to this project using Paypal\"><img src=\"https://img.shields.io/badge/paypal-donate-yellow.svg\" alt=\"PayPal donate button\" /></a></span>\n<span class=\"badge-bitcoin\"><a href=\"https://bevry.me/bitcoin\" title=\"Donate once-off to this project using Bitcoin\"><img src=\"https://img.shields.io/badge/bitcoin-donate-yellow.svg\" alt=\"Bitcoin donate button\" /></a></span>\n<span class=\"badge-wishlist\"><a href=\"https://bevry.me/wishlist\" title=\"Buy an item on our wishlist for us\"><img src=\"https://img.shields.io/badge/wishlist-donate-yellow.svg\" alt=\"Wishlist browse button\" /></a></span>\n\n<!-- /BADGES -->\n\n\n<!-- DESCRIPTION/ -->\n\nScan a directory recursively with a lot of control and power\n\n<!-- /DESCRIPTION -->\n\n\n<!-- INSTALL/ -->\n\n<h2>Install</h2>\n\n<a href=\"https://npmjs.com\" title=\"npm is a package manager for javascript\"><h3>NPM</h3></a><ul>\n<li>Install: <code>npm install --save scandirectory</code></li>\n<li>Module: <code>require('scandirectory')</code></li></ul>\n\n<h3><a href=\"https://github.com/bevry/editions\" title=\"Editions are the best way to produce and consume packages you care about.\">Editions</a></h3>\n\n<p>This package is published with the following editions:</p>\n\n<ul><li><code>scandirectory</code> aliases <code>scandirectory/index.js</code> which uses <a href=\"https://github.com/bevry/editions\" title=\"Editions are the best way to produce and consume packages you care about.\">Editions</a> to automatically select the correct edition for the consumers environment</li>\n<li><code>scandirectory/source/index.js</code> is Source + <a href=\"https://babeljs.io/docs/learn-es2015/\" title=\"ECMAScript Next\">ESNext</a> + <a href=\"https://nodejs.org/dist/latest-v5.x/docs/api/modules.html\" title=\"Node/CJS Modules\">Require</a></li>\n<li><code>scandirectory/es2015/index.js</code> is <a href=\"https://babeljs.io\" title=\"The compiler for writing next generation JavaScript\">Babel</a> Compiled + <a href=\"http://babeljs.io/docs/plugins/preset-es2015/\" title=\"ECMAScript 2015\">ES2015</a> + <a href=\"https://nodejs.org/dist/latest-v5.x/docs/api/modules.html\" title=\"Node/CJS Modules\">Require</a></li></ul>\n\n<p>Older environments may need <a href=\"https://babeljs.io/docs/usage/polyfill/\" title=\"A polyfill that emulates missing ECMAScript environment features\">Babel's Polyfill</a> or something similar.</p>\n\n<!-- /INSTALL -->\n\n\n## Usage\n\n``` javascript\nvar scandir = require('scandirectory')\nvar path = process.cwd()\nvar options = {}\nfunction completionCallback (err, list, tree) {\n\tconsole.log({\n\t\terror: err,\n\t\tlist: list,\n\t\ttree: tree\n\t})\n\t/*\n\t{\n\t\terror: null,\n\t\tlist: {\n\t\t\t'a file.txt': 'file',\n\t\t\t'a directory': 'dir',\n\t\t\t'a directory/a sub file.txt': 'file'\n\t\t},\n\t\ttree: {\n\t\t\t'a file.txt': true,\n\t\t\t'a directory': {\n\t\t\t\t'a sub file.txt': 'true\n\t\t\t}\n\t\t}\n\t}\n\t*/\n}\nscandir(path, options, completionCallback)\n```\n\nScan directory options:\n\n- `action` - (default null) can be `null` or a function to use for both the fileAction and dirAction\n- `fileAction` - (default null) can be `null`, `false`, or a function to be the action callback\n- `dirAction` - (default null) can be `null`, `false`, or a function to the action callback\n- `recurse` - (default true) can be `null` or a boolean for whether or not to scan subdirectories too\n- `readFiles` - (default false) can be `null` or a boolean for whether or not we should read the file contents\n\nThe options object is also sent to [ignorepatterns](https://github.com/bevry/ignorepatterns) so you can use its options too\n\nThe completion callback accepts the following arguments:\n\n- `err` - `null` or an error that has occured\n- `list` - a collection of all the child nodes in a list/object format:\n\t- `{fileRelativePath: 'dir|file'}`\n- `tree` - a collection of all the child nodes in a tree format:\n\t- `{dir: {dir:{}, file1:true} }`\n\t- if the readFiles option is true, then files will be returned with their contents instead\n\nThe results for a specific argument is only generated if the argument is requested.\n\nThe action callbacks accept the following arguments:\n\n- `fullPath` - the full/absolute path of the current file/directory\n- `relativePath` - the relative path of the current file/directory with respect to the original scanning path\n- `filename` - the basename of the current file/directory\n- `stat` - a simple stat object provided by [readdir-cluster](https://github.com/bevry/readdir-cluster)\n\nThe action callbacks can return `false` to skip the path from being processed further.\n\n\n<!-- CONTRIBUTE/ -->\n\n<h2>Contribute</h2>\n\n<a href=\"https://github.com/bevry/scandirectory/blob/master/CONTRIBUTING.md#files\">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>\n\n<!-- /CONTRIBUTE -->\n\n\n<!-- HISTORY/ -->\n\n<h2>History</h2>\n\n<a href=\"https://github.com/bevry/scandirectory/blob/master/HISTORY.md#files\">Discover the release history by heading on over to the <code>HISTORY.md</code> file.</a>\n\n<!-- /HISTORY -->\n\n\n<!-- BACKERS/ -->\n\n<h2>Backers</h2>\n\n<h3>Maintainers</h3>\n\nThese amazing people are maintaining this project:\n\n<ul><li><a href=\"http://balupton.com\">Benjamin Lupton</a> — <a href=\"https://github.com/bevry/scandirectory/commits?author=balupton\" title=\"View the GitHub contributions of Benjamin Lupton on repository bevry/scandirectory\">view contributions</a></li></ul>\n\n<h3>Sponsors</h3>\n\nNo sponsors yet! Will you be the first?\n\n<span class=\"badge-patreon\"><a href=\"http://patreon.com/bevry\" title=\"Donate to this project using Patreon\"><img src=\"https://img.shields.io/badge/patreon-donate-yellow.svg\" alt=\"Patreon donate button\" /></a></span>\n<span class=\"badge-gratipay\"><a href=\"https://www.gratipay.com/bevry\" title=\"Donate weekly to this project using Gratipay\"><img src=\"https://img.shields.io/badge/gratipay-donate-yellow.svg\" alt=\"Gratipay donate button\" /></a></span>\n<span class=\"badge-flattr\"><a href=\"https://flattr.com/profile/balupton\" title=\"Donate to this project using Flattr\"><img src=\"https://img.shields.io/badge/flattr-donate-yellow.svg\" alt=\"Flattr donate button\" /></a></span>\n<span class=\"badge-paypal\"><a href=\"https://bevry.me/paypal\" title=\"Donate to this project using Paypal\"><img src=\"https://img.shields.io/badge/paypal-donate-yellow.svg\" alt=\"PayPal donate button\" /></a></span>\n<span class=\"badge-bitcoin\"><a href=\"https://bevry.me/bitcoin\" title=\"Donate once-off to this project using Bitcoin\"><img src=\"https://img.shields.io/badge/bitcoin-donate-yellow.svg\" alt=\"Bitcoin donate button\" /></a></span>\n<span class=\"badge-wishlist\"><a href=\"https://bevry.me/wishlist\" title=\"Buy an item on our wishlist for us\"><img src=\"https://img.shields.io/badge/wishlist-donate-yellow.svg\" alt=\"Wishlist browse button\" /></a></span>\n\n<h3>Contributors</h3>\n\nThese amazing people have contributed code to this project:\n\n<ul><li><a href=\"http://balupton.com\">Benjamin Lupton</a> — <a href=\"https://github.com/bevry/scandirectory/commits?author=balupton\" title=\"View the GitHub contributions of Benjamin Lupton on repository bevry/scandirectory\">view contributions</a></li>\n<li><a href=\"http://seanfridman.com\">Sean Fridman</a> — <a href=\"https://github.com/bevry/scandirectory/commits?author=sfrdmn\" title=\"View the GitHub contributions of Sean Fridman on repository bevry/scandirectory\">view contributions</a></li></ul>\n\n<a href=\"https://github.com/bevry/scandirectory/blob/master/CONTRIBUTING.md#files\">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>\n\n<!-- /BACKERS -->\n\n\n<!-- LICENSE/ -->\n\n<h2>License</h2>\n\nUnless stated otherwise all works are:\n\n<ul><li>Copyright &copy; 2011+ <a href=\"http://balupton.com\">Benjamin Lupton</a></li>\n<li>Copyright &copy; 2014+ <a href=\"http://bevry.me\">Bevry Pty Ltd</a></li></ul>\n\nand licensed under:\n\n<ul><li><a href=\"http://spdx.org/licenses/MIT.html\">MIT License</a></li></ul>\n\n<!-- /LICENSE -->\n","maintainers":[{"email":"[email protected]","name":"balupton"},{"email":"[email protected]","name":"bevryme"}],"time":{"modified":"2019-01-05T10:49:15.465Z","created":"2014-12-17T03:39:11.780Z","2.5.0":"2014-12-17T03:39:11.780Z","3.0.0":"2016-10-20T07:45:57.433Z","3.0.1":"2016-10-20T07:48:17.397Z"},"homepage":"https://github.com/bevry/scandirectory","keywords":["path","fs","scandir","scandirectory","scantree","scanlist","recursive","tree"],"repository":{"type":"git","url":"git+https://github.com/bevry/scandirectory.git"},"contributors":[{"name":"Benjamin Lupton","email":"[email protected]","url":"http://balupton.com"},{"name":"Sean Fridman","email":"[email protected]","url":"http://seanfridman.com"}],"author":{"name":"2011+ Benjamin Lupton","email":"[email protected]","url":"http://balupton.com"},"bugs":{"url":"https://github.com/bevry/scandirectory/issues"},"license":"MIT","readmeFilename":"README.md","_etag":"W/\"0376a2f9d7a08d9cf6c8ae981284f95d\"","_lastModified":"Sat, 05 Jan 2019 10:49:16 GMT"}