{"_id":"pkgfiles","_rev":"2784973","name":"pkgfiles","description":"List all files which would be published in a package.","dist-tags":{"latest":"2.3.2"},"maintainers":[{"name":"timoxley","email":""}],"time":{"modified":"2022-06-13T08:03:22.000Z","created":"2014-09-28T09:43:28.040Z","2.3.2":"2016-12-09T12:48:38.011Z","2.3.0":"2015-05-11T00:41:10.293Z","2.2.2":"2015-05-10T23:34:03.201Z","2.2.1":"2015-05-10T23:26:53.074Z","2.2.0":"2015-04-28T06:41:27.607Z","2.1.1":"2014-12-11T16:02:45.203Z","2.1.0":"2014-12-08T05:14:49.619Z","2.0.0":"2014-12-08T04:52:17.106Z","1.0.0":"2014-09-28T09:43:28.040Z"},"users":{},"author":{"name":"Tim Oxley","email":"secoif@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/timoxley/pkgfiles.git"},"versions":{"2.3.2":{"name":"pkgfiles","version":"2.3.2","description":"List all files which would be published in a package.","main":"index.js","bin":{"pkgfiles":"bin/pkgfiles.js"},"scripts":{"test":"tape test/*.js"},"keywords":["npm","publish","dependencies","files","package"],"author":{"name":"Tim Oxley","email":"secoif@gmail.com"},"license":"MIT","dependencies":{"columnify":"^1.5.4","du":"^0.1.0","fstream-npm":"^1.2.0","map-limit":"0.0.1","minimist":"^1.2.0","pkgresolve":"^1.1.4","pretty-bytes":"^4.0.2"},"devDependencies":{"tape":"~4.6.3"},"directories":{"test":"test"},"repository":{"type":"git","url":"git+https://github.com/timoxley/pkgfiles.git"},"bugs":{"url":"https://github.com/timoxley/pkgfiles/issues"},"homepage":"https://github.com/timoxley/pkgfiles","gitHead":"8e60f04b05a7cb2ed22d709fe5369f07f3ba3b08","_id":"pkgfiles@2.3.2","_shasum":"1b54a7a8dbe32caa84b0955f44917e1500d33d05","_from":".","_npmVersion":"3.10.8","_nodeVersion":"6.9.1","_npmUser":{"name":"timoxley","email":"secoif@gmail.com"},"dist":{"shasum":"1b54a7a8dbe32caa84b0955f44917e1500d33d05","size":8977,"noattachment":false,"key":"/pkgfiles/-/pkgfiles-2.3.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/pkgfiles/download/pkgfiles-2.3.2.tgz"},"maintainers":[{"name":"timoxley","email":""}],"_npmOperationalInternal":{"host":"packages-18-east.internal.npmjs.com","tmp":"tmp/pkgfiles-2.3.2.tgz_1481287715848_0.661357962526381"},"publish_time":1481287718011,"_hasShrinkwrap":false,"_cnpm_publish_time":1481287718011,"_cnpmcore_publish_time":"2021-12-16T22:06:46.671Z"},"2.3.0":{"name":"pkgfiles","version":"2.3.0","description":"List all files which would be published in a package.","main":"index.js","bin":{"pkgfiles":"bin/pkgfiles.js"},"scripts":{"test":"tape test/*.js"},"keywords":["npm","publish","dependencies","files","package"],"author":{"name":"Tim Oxley","email":"secoif@gmail.com"},"license":"MIT","dependencies":{"columnify":"^1.5.1","du":"^0.1.0","fstream-npm":"~1.0.2","map-limit":"0.0.1","minimist":"~1.1.1","pkgresolve":"~1.1.3","pretty-bytes":"^1.0.4"},"devDependencies":{"tape":"~4.0.0"},"directories":{"test":"test"},"repository":{"type":"git","url":"git+https://github.com/timoxley/pkgfiles.git"},"bugs":{"url":"https://github.com/timoxley/pkgfiles/issues"},"homepage":"https://github.com/timoxley/pkgfiles","gitHead":"2da1723e1e60a142ec11550a834fd707e269271c","_id":"pkgfiles@2.3.0","_shasum":"d85d9948e80750b33f7e0695130d47c945f45d16","_from":".","_npmVersion":"2.10.0","_nodeVersion":"1.8.1","_npmUser":{"name":"timoxley","email":"secoif@gmail.com"},"maintainers":[{"name":"timoxley","email":""}],"dist":{"shasum":"d85d9948e80750b33f7e0695130d47c945f45d16","size":5680,"noattachment":false,"key":"/pkgfiles/-/pkgfiles-2.3.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/pkgfiles/download/pkgfiles-2.3.0.tgz"},"publish_time":1431304870293,"_hasShrinkwrap":false,"_cnpm_publish_time":1431304870293,"_cnpmcore_publish_time":"2021-12-16T22:06:46.902Z"},"2.2.2":{"name":"pkgfiles","version":"2.2.2","description":"List all files which would be published in a package.","main":"index.js","bin":{"pkgfiles":"bin/pkgfiles.js"},"scripts":{"test":"tape test/*.js"},"keywords":["npm","publish","dependencies","files","package"],"author":{"name":"Tim Oxley","email":"secoif@gmail.com"},"license":"MIT","dependencies":{"columnify":"^1.5.1","du":"^0.1.0","fstream-npm":"~1.0.2","map-limit":"0.0.1","minimist":"~1.1.1","pkgresolve":"~1.1.3","pretty-bytes":"^1.0.4"},"devDependencies":{"tape":"~4.0.0"},"directories":{"test":"test"},"repository":{"type":"git","url":"git+https://github.com/timoxley/pkgfiles.git"},"bugs":{"url":"https://github.com/timoxley/pkgfiles/issues"},"homepage":"https://github.com/timoxley/pkgfiles","gitHead":"2bdc9aff6af694f34761ee453459801166d6d5d6","_id":"pkgfiles@2.2.2","_shasum":"d5435ed4ae9331dfd523aedc1077f3b841a550b5","_from":".","_npmVersion":"2.10.0","_nodeVersion":"1.8.1","_npmUser":{"name":"timoxley","email":"secoif@gmail.com"},"maintainers":[{"name":"timoxley","email":""}],"dist":{"shasum":"d5435ed4ae9331dfd523aedc1077f3b841a550b5","size":5613,"noattachment":false,"key":"/pkgfiles/-/pkgfiles-2.2.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/pkgfiles/download/pkgfiles-2.2.2.tgz"},"publish_time":1431300843201,"_hasShrinkwrap":false,"_cnpm_publish_time":1431300843201,"_cnpmcore_publish_time":"2021-12-16T22:06:47.123Z"},"2.2.1":{"name":"pkgfiles","version":"2.2.1","description":"List all files which would be published in a package.","main":"index.js","bin":{"pkgfiles":"bin/pkgfiles.js"},"scripts":{"test":"tape test/*.js"},"keywords":["npm","publish","dependencies","files","package"],"author":{"name":"Tim Oxley","email":"secoif@gmail.com"},"license":"MIT","dependencies":{"columnify":"^1.5.1","du":"^0.1.0","fstream-npm":"~1.0.2","map-limit":"0.0.1","minimist":"~1.1.1","pkgresolve":"~1.1.3","pretty-bytes":"^1.0.4"},"devDependencies":{"tape":"~4.0.0"},"directories":{"test":"test"},"repository":{"type":"git","url":"git+https://github.com/timoxley/pkgfiles.git"},"bugs":{"url":"https://github.com/timoxley/pkgfiles/issues"},"homepage":"https://github.com/timoxley/pkgfiles","gitHead":"2c7369a28d4ef3454cd2db7541ea672b916816fa","_id":"pkgfiles@2.2.1","_shasum":"623b285bb7cb3c9595bd1b9b4eb04a4834453e27","_from":".","_npmVersion":"2.10.0","_nodeVersion":"1.8.1","_npmUser":{"name":"timoxley","email":"secoif@gmail.com"},"maintainers":[{"name":"timoxley","email":""}],"dist":{"shasum":"623b285bb7cb3c9595bd1b9b4eb04a4834453e27","size":5614,"noattachment":false,"key":"/pkgfiles/-/pkgfiles-2.2.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/pkgfiles/download/pkgfiles-2.2.1.tgz"},"publish_time":1431300413074,"_hasShrinkwrap":false,"_cnpm_publish_time":1431300413074,"_cnpmcore_publish_time":"2021-12-16T22:06:47.649Z"},"2.2.0":{"name":"pkgfiles","version":"2.2.0","description":"List all files which would be published in a package.","main":"index.js","bin":{"pkgfiles":"bin/pkgfiles.js"},"scripts":{"test":"tape test/*.js"},"keywords":["npm","publish","dependencies","files","package"],"author":{"name":"Tim Oxley","email":"secoif@gmail.com"},"license":"MIT","dependencies":{"columnify":"^1.5.1","du":"^0.1.0","fstream-npm":"~1.0.2","map-limit":"0.0.1","minimist":"~1.1.1","pkgresolve":"~1.1.3","pretty-bytes":"^1.0.4"},"devDependencies":{"tape":"~4.0.0"},"directories":{"test":"test"},"repository":{"type":"git","url":"git+https://github.com/timoxley/pkgfiles.git"},"bugs":{"url":"https://github.com/timoxley/pkgfiles/issues"},"homepage":"https://github.com/timoxley/pkgfiles","gitHead":"7dca55f33eedfeeec55326016695090fabf4ab7e","_id":"pkgfiles@2.2.0","_shasum":"1a024be91fbb032b539de10b2f080e7f1eea2cbb","_from":".","_npmVersion":"2.8.3","_nodeVersion":"1.8.1","_npmUser":{"name":"timoxley","email":"secoif@gmail.com"},"maintainers":[{"name":"timoxley","email":""}],"dist":{"shasum":"1a024be91fbb032b539de10b2f080e7f1eea2cbb","size":5613,"noattachment":false,"key":"/pkgfiles/-/pkgfiles-2.2.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/pkgfiles/download/pkgfiles-2.2.0.tgz"},"publish_time":1430203287607,"_hasShrinkwrap":false,"_cnpm_publish_time":1430203287607,"_cnpmcore_publish_time":"2021-12-16T22:06:47.853Z"},"2.1.1":{"name":"pkgfiles","version":"2.1.1","description":"List all files which would be published in a package.","main":"index.js","bin":{"pkgfiles":"bin/pkgfiles.js"},"scripts":{"test":"tape test/*.js"},"keywords":["npm","publish","dependencies","files","package"],"author":{"name":"Tim Oxley","email":"secoif@gmail.com"},"license":"MIT","dependencies":{"columnify":"^1.3.2","du":"^0.1.0","fstream-npm":"~1.0.0","map-limit":"0.0.1","minimist":"~1.1.0","pkgresolve":"~1.0.0","pretty-bytes":"^1.0.2"},"devDependencies":{"tape":"~3.0.0"},"directories":{"test":"test"},"repository":{"type":"git","url":"https://github.com/timoxley/pkgfiles.git"},"bugs":{"url":"https://github.com/timoxley/pkgfiles/issues"},"homepage":"https://github.com/timoxley/pkgfiles","gitHead":"91ffeb90f5653f3b6dca7e5b1035b0464479b642","_id":"pkgfiles@2.1.1","_shasum":"720fa4984d0f426f8914a6709686401d38e04155","_from":".","_npmVersion":"2.1.11","_nodeVersion":"0.10.33","_npmUser":{"name":"timoxley","email":"secoif@gmail.com"},"maintainers":[{"name":"timoxley","email":""}],"dist":{"shasum":"720fa4984d0f426f8914a6709686401d38e04155","size":5553,"noattachment":false,"key":"/pkgfiles/-/pkgfiles-2.1.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/pkgfiles/download/pkgfiles-2.1.1.tgz"},"publish_time":1418313765203,"_hasShrinkwrap":false,"_cnpm_publish_time":1418313765203,"_cnpmcore_publish_time":"2021-12-16T22:06:48.129Z"},"2.1.0":{"name":"pkgfiles","version":"2.1.0","description":"List all files which would be published in a package.","main":"index.js","bin":{"pkgfiles":"bin/pkgfiles.js"},"scripts":{"test":"tape test/*.js"},"keywords":["npm","publish","dependencies","files","package"],"author":{"name":"Tim Oxley","email":"secoif@gmail.com"},"license":"MIT","dependencies":{"columnify":"^1.3.2","du":"^0.1.0","fstream-npm":"~1.0.0","minimist":"~1.1.0","pkgresolve":"~1.0.0","pretty-bytes":"^1.0.2"},"devDependencies":{"tape":"~3.0.0"},"directories":{"test":"test"},"repository":{"type":"git","url":"https://github.com/timoxley/pkgfiles.git"},"bugs":{"url":"https://github.com/timoxley/pkgfiles/issues"},"homepage":"https://github.com/timoxley/pkgfiles","gitHead":"c2acbef9aa85eed558db88e599bdc03d7be2a3f7","_id":"pkgfiles@2.1.0","_shasum":"1fb68d2ed39146c157db11ebfa18a17a39cd0e94","_from":".","_npmVersion":"2.1.10","_nodeVersion":"0.10.33","_npmUser":{"name":"timoxley","email":"secoif@gmail.com"},"maintainers":[{"name":"timoxley","email":""}],"dist":{"shasum":"1fb68d2ed39146c157db11ebfa18a17a39cd0e94","size":4787,"noattachment":false,"key":"/pkgfiles/-/pkgfiles-2.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/pkgfiles/download/pkgfiles-2.1.0.tgz"},"publish_time":1418015689619,"_hasShrinkwrap":false,"_cnpm_publish_time":1418015689619,"_cnpmcore_publish_time":"2021-12-16T22:06:48.361Z"},"2.0.0":{"name":"pkgfiles","version":"2.0.0","description":"List all files which would be published in a package.","main":"index.js","bin":{"pkgfiles":"bin/pkgfiles.js"},"scripts":{"test":"tape test/*.js"},"keywords":["npm","publish","dependencies","files","package"],"author":{"name":"Tim Oxley","email":"secoif@gmail.com"},"license":"MIT","dependencies":{"columnify":"^1.3.2","du":"^0.1.0","fstream-npm":"~1.0.0","minimist":"~1.1.0","pkgresolve":"~1.0.0","pretty-bytes":"^1.0.2"},"devDependencies":{"tape":"~3.0.0"},"directories":{"test":"test"},"repository":{"type":"git","url":"https://github.com/timoxley/pkgfiles.git"},"bugs":{"url":"https://github.com/timoxley/pkgfiles/issues"},"homepage":"https://github.com/timoxley/pkgfiles","gitHead":"05ff7a2acd6be4c9922f7db74c34a981738644b2","_id":"pkgfiles@2.0.0","_shasum":"197706e4684c7d1336d48e9ef69c1e31f41b1e26","_from":".","_npmVersion":"2.1.10","_nodeVersion":"0.10.33","_npmUser":{"name":"timoxley","email":"secoif@gmail.com"},"maintainers":[{"name":"timoxley","email":""}],"dist":{"shasum":"197706e4684c7d1336d48e9ef69c1e31f41b1e26","size":4512,"noattachment":false,"key":"/pkgfiles/-/pkgfiles-2.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/pkgfiles/download/pkgfiles-2.0.0.tgz"},"publish_time":1418014337106,"_hasShrinkwrap":false,"_cnpm_publish_time":1418014337106,"_cnpmcore_publish_time":"2021-12-16T22:06:48.591Z"},"1.0.0":{"name":"pkgfiles","version":"1.0.0","description":"List all files which would be published in a package.","main":"index.js","bin":{"pkgfiles":"bin/pkgfiles.js"},"scripts":{"test":"tape test/*.js"},"keywords":["npm","publish","dependencies","files","package"],"author":{"name":"Tim Oxley","email":"secoif@gmail.com"},"license":"MIT","dependencies":{"fstream-npm":"~1.0.0","minimist":"~1.1.0","pkgresolve":"~1.0.0"},"devDependencies":{"tape":"~3.0.0"},"directories":{"test":"test"},"repository":{"type":"git","url":"https://github.com/timoxley/pkgfiles.git"},"bugs":{"url":"https://github.com/timoxley/pkgfiles/issues"},"homepage":"https://github.com/timoxley/pkgfiles","gitHead":"493090b109c46419a2923b900754655744bfbaaa","_id":"pkgfiles@1.0.0","_shasum":"5c22f6fe41d49620850e62e82ca912c4ac812392","_from":".","_npmVersion":"2.0.2","_nodeVersion":"0.10.32","_npmUser":{"name":"timoxley","email":"secoif@gmail.com"},"maintainers":[{"name":"timoxley","email":""}],"dist":{"shasum":"5c22f6fe41d49620850e62e82ca912c4ac812392","size":2707,"noattachment":false,"key":"/pkgfiles/-/pkgfiles-1.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/pkgfiles/download/pkgfiles-1.0.0.tgz"},"publish_time":1411897408040,"_hasShrinkwrap":false,"_cnpm_publish_time":1411897408040,"_cnpmcore_publish_time":"2021-12-16T22:06:48.833Z"}},"readme":"# pkgfiles\n\n### List all files which would be published in a package.\n\n[![Build Status](https://travis-ci.org/timoxley/pkgfiles.svg)](https://travis-ci.org/timoxley/pkgfiles)\n\nUseful for double-checking you're not publishing anything\nunwanted prior to an `npm publish`.\n\nNote some files may not yet exist (e.g. `.npmignore`).\n\n## Installation\n\n```\nnpm install pkgfiles\n```\n\n### CLI\n\n```\n> pkgfiles\n\nFILE                   SIZE     %\ntest/pkg/lib/index.js  0 B      0%\ntest/pkg/index.js      0 B      0%\n.npmignore             N/A\n.travis.yml            84 B     1%\ntest/pkg/package.json  269 B    2%\ntest/index.js          739 B    6%\npackage.json           900 B    7%\nLICENSE                1.08 kB  9%\nindex.js               2.99 kB  24%\nReadme.md              3.12 kB  25%\nbin/pkgfiles.js        3.43 kB  27%\n\nPKGFILES SUMMARY\nSize with Dependencies  ~885.15 kB\nPublishable Size        ~12.61 kB\nNumber of Files         11\n```\n\n```\n> pkgfiles --disk\n\nFILE                   SIZE     %    DISK SIZE  DISK SIZE %\ntest/pkg/lib/index.js  0 B      0%   0 B        0%\ntest/pkg/index.js      0 B      0%   0 B        0%\n.npmignore             N/A\n.travis.yml            84 B     1%   4.1 kB     13%\ntest/pkg/package.json  269 B    2%   4.1 kB     13%\ntest/index.js          519 B    5%   4.1 kB     13%\npackage.json           900 B    8%   4.1 kB     13%\nLICENSE                1.08 kB  9%   4.1 kB     13%\nReadme.md              2.37 kB  21%  4.1 kB     13%\nindex.js               2.99 kB  26%  4.1 kB     13%\nbin/pkgfiles.js        3.26 kB  28%  4.1 kB     13%\n\nPKGFILES SUMMARY\nSize on Disk with Dependencies  ~2.34 MB\nSize with Dependencies          ~865.27 kB\nPublishable Size on Disk        ~32.77 kB\nPublishable Size                ~11.47 kB\nNumber of Files                 11\n```\n\n```\n> pkgfiles --sort=name\n\nFILE                   SIZE     %\n.npmignore             N/A\n.travis.yml            84 B     1%\nLICENSE                1.08 kB  8%\nReadme.md              4.24 kB  31%\nbin/pkgfiles.js        3.5 kB   25%\nindex.js               2.99 kB  22%\npackage.json           900 B    7%\ntest/index.js          739 B    5%\ntest/pkg/index.js      0 B      0%\ntest/pkg/lib/index.js  0 B      0%\ntest/pkg/package.json  269 B    2%\n\nPKGFILES SUMMARY\nSize with Dependencies  ~886.34 kB\nPublishable Size        ~13.8 kB\nNumber of Files         11\n```\n\n## API\n\nAll sizes are in bytes.\n\n```js\nvar pkgfiles = require('pkgfiles')\n\n\npkgfiles(process.cwd(), function(err, entries, packages) {\n  // entries: Array of information about files and dirs that would be included\n  // packages: Array of package.jsons that would be included\n\n  entries.forEach(function(entry) {\n    console.log('%s – %d bytes', entry.file, entry.size)\n  })\n  // /Users/timoxley/Projects/pkgfiles/package.json – 900 bytes\n  // /Users/timoxley/Projects/pkgfiles/.npmignore – 0 bytes\n  // /Users/timoxley/Projects/pkgfiles/LICENSE – 1076 bytes\n  // /Users/timoxley/Projects/pkgfiles/index.js – 2933 bytes\n  // /Users/timoxley/Projects/pkgfiles/.travis.yml – 84 bytes\n  // /Users/timoxley/Projects/pkgfiles/Readme.md – 1684 bytes\n  // /Users/timoxley/Projects/pkgfiles/bin/pkgfiles.js – 2927 bytes\n  // /Users/timoxley/Projects/pkgfiles/test/index.js – 519 bytes\n  // /Users/timoxley/Projects/pkgfiles/test/pkg/package.json – 269 bytes\n  // /Users/timoxley/Projects/pkgfiles/test/pkg/index.js – 0 bytes\n  // /Users/timoxley/Projects/pkgfiles/test/pkg/lib/index.js – 0 bytes\n})\n```\n\n```js\nvar pkgfiles = require('pkgfiles')\n\npkgfiles.summary(process.cwd(), function(err, results) {\n  results.entries // entries from pkgFiles\n  results.packages // packages from pkgFiles\n  results.extractedSize // size including dependencies\n  results.extractedDiskSize // size on disk including dependencies\n  results.publishSize // size excluding dependencies\n  results.publishDiskSize // size on diesk excluding dependencies\n})\n```\n\n## Description\n\nThis is a wrapper around whatever version of `fstream-npm` is installed in\nthe **global** `npm`. It has an async callback interface (instead of a\nstream), and keeps the original path (instead of nesting paths in\n'package').\n\n## See Also\n\n* [thlorenz/irish-pub](https://www.npmjs.org/package/irish-pub)\n* [timoxley/pkgcount](https://github.com/timoxley/pkgcount)\n* [timoxley/pkgrep](https://github.com/timoxley/pkgrep)\n\n# License\n\nMIT\n","_attachments":{},"homepage":"https://github.com/timoxley/pkgfiles","bugs":{"url":"https://github.com/timoxley/pkgfiles/issues"},"license":"MIT"}