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

walk-it

v5.0.1

Published

Async file walk iterator

Downloads

139

Readme

walk-it

TS ready ESM ready Deno ready Bun ready Node.js CI npm jsr npm bundle size codecov GitHub

Recursive file walk-iterator. Requires Node 18+, Deno or Bun.

Install (Node)

npm i walk-it
pnpm i walk-it
yarn add walk-it
bun install walk-it

Install (JSR)

npx jsr add @svarta/walk-it
pnpm jsr add @svarta/walk-it
yarn jsr add @svarta/walk-it
bunx jsr add @svarta/walk-it

Deno usage

import { walk } from "npm:walk-it";

Default behaviour

By default, all folders will be visited recursively starting at the given directory.

Note that subfolders are visited eagerly, meaning the level is not sorted (aka. pre-order traversal is used instead of level-order).

Usage & examples

Walk all folders recursively

import { walk } from "walk-it";

for await (const x of walk(dir)) {
  // x contains:
  // dir    : the scanned folder's absolute path
  // files  : files as directory entries (Dirent)
  // folders: folders as directory entries (Dirent)
  // level  : the tree level (0 being the start directory)
  console.log(x);
}

Get files only

import { walkFiles } from "walk-it";

for await (const { file, path } of walkFiles(dir)) {
  // file is a Dirent object
  // path is the absolute path of the visited file
  console.log(file, path);
}

Limit recursive descent

import { walk } from "walk-it";

// 0 = Only output 'dir'
// 1 = Descent once
// 2 = Descent twice
// ...
for await (const x of walk(dir, { maxLevel: 2 })) {
  console.log(x);
}

Disable recursive descent altogether

Same as maxLevel = 0

import { walk } from "walk-it";

for await (const x of walk(dir, { recursive: false })) {
  console.log(x);
}

Whitelist files by extension

import { walk } from "walk-it";

for await (const x of walk(".", {
  filterFile: ({ name }) => name.endsWith(".jpg"),
})) {
  console.log(x);
}

Blacklist folders

import { walk } from "walk-it";

for await (const x of walk(".", {
  filterFolder: ({ name }) => !["node_modules", ".git"].includes(name),
})) {
  console.log(x);
}

filterFolder should be preferred over filtering after walking because it will stop the recursive descent, thus increasing performance.

Count files

import { countFiles } from "walk-it";

const count = await countFiles(".");
console.log(`${count} files found`);

const count = await countFiles(".", {
  // You can also use the same options as walk and walkFiles
  filterFolder: ({ name }) => !["node_modules", ".git"].includes(name),
});
console.log(`${count} files found`);