npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2022 – Pkg Stats / Ryan Hefner

filesizes

v0.1.2

Published

Command line utility for outputing the size of files within a given directory.

Downloads

141

Readme

📂⚖️ filesizes

Easily review the size of files in a given directory and its subdirectories.

Install

Via NPM

npm install --save filesizes

CLI (command line tool)

npm install -g filesizes

How to use

You can use this module in two ways. The first, is a simple way to get an array of all the file names and the size of each file within a given directory and its subdirectories. You can also use the included CLI (command line tool) that lets you initiate the command against a folder on your machine.

Here are some examples on how you would use them, both in a project or via the command line.

Import

Using this tool in your project, it returns an array for each file that include the name and size for each file that match your criteria. This can be handy for CMS tools that need to show a listing of files and their file sizes, or if you have some admin features that you want to use to manage files on your server.

Example

import fileSizes from 'filesizes';

const fileInfo = fileSizes();
fileInfo.forEach(info => console.log(file.name, file.size));

Options

The fileSizes method accepts an object allowing you to define the options that are used when generating the array of file names and sizes. The following options can be set when you execute the method.

  • dir - Initial directory to traverse the files and subdirectories. (Default: ./)
  • excludeFiles - Array of either basic strings or regular expressions of files to exclude from the list. (Default: ['.DS_Store', '.DS_Store?', '.Spotlight-V100', '.Trashes', 'ehthumbs.db', 'Thumbs.db'])
  • excludeDirectories - Array of either basic string or regular expressions of directories to exclude from the list. (Default: ['.git', 'node_modules', 'vendor'])
  • verbose - For use when running the CLI command. Outputs progress of files checked while traversing the directory. (Default: false)

CLI (command line tool)

In addition to the standard method, this module includes a handy command line tool that lets you run the command and generates a table listing all the files that match your criteria, along with their file size and size of file when gzipped.

I’ve found this handy for being able to quickly assess the size of assets for a project, or hunt down a large file that is taking up too much space on my computer.

Examples

$ filesizes [options] [dir]

Initiate command with options and dir argument. Listing all files in the public directory in the current directory and flagging files that are greater than 1,000,000 bytes (1 MB).

$ filesizes -l 1000000 public

Arguments

  • dir - Initial directory to traverse the files and subdirectories. (Default: ./)

Options

  • -f, --exclude-file - Comma-delimited list of either basic strings or regular expressions of files to exclude from the list. (Default: '.DS_Store, .DS_Store?, .Spotlight-V100, .Trashes, ehthumbs.db, Thumbs.db')
  • -d, --exclude-directories - Comma-delimited list of either basic string or regular expressions of directories to exclude from the list. (Default: '.git, node_modules, vendor')
  • -l, --large-file - Size used to flag a file as being too large. Files that meet or exceed this value will be represented in red in the outputted table. (Default: null)
  • -v, --verbose - Output the progress of files checked while traversing the directory.

License

MIT © Ryan Hefner