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

@universal-packages/directory-traversal

v1.3.6

Published

Simple tool to traverse a directory deeply and get desired info

Downloads

51,928

Readme

Directory Traversal

npm version Testing codecov

Sometimes you just need a way to map a directory to either load modules in real time or just get the available files to run a task, directory traversal will map a directory for you and deliver a convenient DirectoryMap object for you.

Install

npm install @universal-packages/directory-traversal

Global methods

traverse(locations: String, [options])

The traverse function will go recursively from a root directory until it maps the whole tree, you can execute a callback for every visited directory after being mapped, limit the depth and filter for files you want or you not want to be mapped, returning a DirectoryMap object

import { traverse } from '@universal-packages/directory-traversal'

const directoryMap = traverse('~/projects')

console.log(directoryMap)

Options

You can modify the behavior of the traverse function by providing options.

  • callback Function A function to call for every mapped directory for you to analyze in place, return false if you want to stop going deeper into that directory.

    const directoryMap = traverse('~/projects', {
      callback: (directoryMap) => {
        if (directoryMap.path.include('homework')) {
          return false
        }
      }
    })
  • fileFilter (yml | yaml | js | json)[] | Regex To only include files that satisfies this condition.

  • maxDepth Number To only map files going this level deep.

DirectoryMap

From the traverse example you will get something like this:

{
  "path": "home/projects",
  "files": [],
  "directories": [
    {
      "path": "home/projects/universal-directory-traversal",
      "files": [
        "home/projects/universal-directory-traversal/.editorconfig",
        "home/projects/universal-directory-traversal/.gitignore",
        "home/projects/universal-directory-traversal/CODE-OF-CONDUCT.md",
        "home/projects/universal-directory-traversal/CONTRIBUTING.md",
        "home/projects/universal-directory-traversal/LICENSE.md",
        "home/projects/universal-directory-traversal/README.md",
        "home/projects/universal-directory-traversal/package-lock.json",
        "home/projects/universal-directory-traversal/package.json",
        "home/projects/universal-directory-traversal/tsconfig.dis.json",
        "home/projects/universal-directory-traversal/tsconfig.json"
      ],
      "directories": []
    }
  ]
}

Typescript

This library is developed in TypeScript and shipped fully typed.

Contributing

The development of this library happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this library.

License

MIT licensed.