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 🙏

© 2024 – Pkg Stats / Ryan Hefner

list-filepaths

v1.6.5

Published

Asynchronously return an array containing the paths of all files in a directory and its subdirectories

Downloads

106

Readme

list-filepaths

npm node CircleCI Coveralls styled with prettier

Asynchronously return an array containing the paths of all files in a directory and its subdirectories

Install

$ npm install list-filepaths --save

Usage

For a directory tree...

└─┬ episode-v
  └─┬ ships
    ├─┬ millennium-falcon
    │ ├── millennium-falcon.js
    │ └─┬ pilots
    │   ├── chewbacca.js
    │   └── han-solo.js
    ├─┬ slave-i
    │ ├─┬ pilots
    │ │ └── boba-fett.js
    │ └── slave-i.js
    └──t-47

Return a Promise that is resolved with an alphabetically-sorted array of the paths of all files in a directory and its subdirectories. An options object can be passed as a second argument to filter the results, reject matching paths, or to return relative file paths instead of absolute file paths.

const listFilepaths = require('list-filepaths');

// Inside episode-v
listFilepaths('./ships')
  .then(filepaths => {
    // Process filepaths
    console.log(filepaths);
  })
  .catch(err => {
    // Handle errors
    console.error(err);
  });

// [
//   '/episode-v/ships/millennium-falcon/millennium-falcon.js',
//   '/episode-v/ships/millennium-falcon/pilots/chewbacca.js',
//   '/episode-v/ships/millennium-falcon/pilots/han-solo.js',
//   '/episode-v/ships/slave-i/pilots/boba-fett.js',
//   '/episode-v/ships/slave-i/slave-i.js'
// ]

API

const listFilepaths = require('list-filepaths');

listFilepaths(directoryPath[, options])

Returns a Promise that is resolved with an array containing the absolute paths of all files in the target directory and its subdirectories or null if no file paths are found. File paths are sorted alphabetically.

directoryPath

  • type: String

The relative or absolute path of the target directory.

options.depth

  • type: Number

The maximum search depth of the directory tree.

options.filter

  • type: RegExp or Function

A regular expression instance against which to test each file path or a callback function to pass to the Array.prototype.filter method. The filter option is used on the final array and matching paths are included in the result.

options.reject

  • type: RegExp or Function

Similar to filter except matched paths are excluded from the result. Reject is used on each recursive call and, as such, is more efficient than filter as it will skip recursive calls on matching paths.

options.relative

  • type: Boolean

  • default: false

Set to true to return a list of relative paths.