glob-size v1.0.1

glob-size

Get the total size of a glob of files.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save glob-size

This is similar to the UNIX du command (try du -sh * for example), but has a JavaScript API. This can be used in linters or build tools, etc. (this is also similar to doing something like ls -l *).

CLI usage

$ gs
$ gs *
$ gs "**" -t
$ gs "**" -d node_modules

Options:
  --cwd, -d      directory to search from                         [default: "."]
  --pattern, -p  one or more glob patterns, comma-separated
  --table, -t    Show a text table of files sorted by size
  --stats, -s    log out the entire stats object with all files
  --help         Show help                                             [boolean]

API usage

const size = require('glob-size');

Params

• patterns {string|array}
• options {object}
• returns {promise}

Example

// get the size of all files in the cwd
size('*')
  .then(console.log)
  .catch(console.error)

.sync

Synchronously get the size of all files that match the given glob patterns.

Params

• patterns {String|Array}
• options {Object}
• returns {Object}

Example

// get the size of all files in the cwd
const stats = size.sync('*');
console.log(stats);

.stats.top

Returns the top n files by size, sorted in ascending order. (this method is exposed on the returned stats object)

Params

• n {Number}: The number of files to return.
• returns {Array}: Array of the top n files

Example

size('node_modules/**')
  .then(stats => console.log(stats.top(25)))
  .catch(console.error);

.stats.tableize

Create a text table from the stats.files array returned by the main export, or from the .top method. (this method is exposed on the returned stats object)

Params

• files {Array}
• returns {String}

Example

// tableize the 3 largest files in "node_modules/**"
size('node_modules/**')
  .then(stats => console.log(stats.table(stats.top(3))))
  .catch(console.error);

// tableize all files
size('node_modules/**')
  .then(stats => console.log(stats.table(stats.files)))
  .catch(console.error);

Examples

The following examples assume the code is inside an async function.

// get the size of all `.js` files in the cwd
console.log(await size('*.js'));

// get the size of all `.js` files in "./foo"
console.log(await size('*.js', { cwd: 'foo' }));

// show the 25 largest files in "node_modules/**"
const stats = await size('node_modules/**');
console.log(stats.top(25));

// show the 3 largest files in "node_modules/**"
const stats = await size('node_modules/**');
console.log(stats.top(3));

// show the 3 largest files in "node_modules/**"
const stats = await size('node_modules/**');
console.log(stats.top(3));

// tableize the 3 largest files in "node_modules/**"
const stats = await size('node_modules/**');
console.log(stats.table(stats.top(50)));

// tableize all files
const stats = await size('node_modules/**');
console.log(stats.table(stats.files));

About

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Author

Jon Schlinkert

• LinkedIn Profile
• GitHub Profile
• Twitter Profile

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on May 16, 2018.