klaw

What is klaw?

The 'klaw' npm package is a file system walker that allows you to recursively traverse directories and perform actions on files and directories. It is useful for tasks such as file searching, filtering, and processing.

What are klaw's main functionalities?

Recursively Traverse Directories

This feature allows you to recursively traverse directories starting from a specified path. The code sample demonstrates how to use 'klaw' to log the path of each file and directory it encounters.

const klaw = require('klaw');
const path = require('path');

klaw('/some/dir')
  .on('data', item => console.log(item.path))
  .on('end', () => console.log('All done!'));

Filter Files and Directories

This feature allows you to filter files and directories based on a custom function. The code sample demonstrates how to use 'klaw' to only log the paths of JavaScript files.

const klaw = require('klaw');
const path = require('path');

const filterFunc = item => path.extname(item) === '.js';

klaw('/some/dir', { filter: filterFunc })
  .on('data', item => console.log(item.path))
  .on('end', () => console.log('All done!'));

Handle Errors

This feature allows you to handle errors that occur during the directory traversal. The code sample demonstrates how to use 'klaw' to log errors to the console.

const klaw = require('klaw');
const path = require('path');

klaw('/some/dir')
  .on('data', item => console.log(item.path))
  .on('error', err => console.error('Error:', err))
  .on('end', () => console.log('All done!'));

Other packages similar to klaw

readdirp

The 'readdirp' package is another file system walker that allows you to recursively read directories and filter files. It provides a similar functionality to 'klaw' but with a different API. 'readdirp' is known for its simplicity and ease of use.

walk

The 'walk' package is a file system walker that allows you to traverse directories and perform actions on files and directories. It provides a similar functionality to 'klaw' but with a more event-driven API. 'walk' is known for its flexibility and customization options.

node-dir

The 'node-dir' package provides functions to read directories and files recursively. It offers similar functionalities to 'klaw' but with a more straightforward API. 'node-dir' is known for its simplicity and ease of integration.

README

Node.js - klaw

A Node.js file system walker extracted from fs-extra.

Install

npm i --save klaw

Name

klaw is walk backwards :p

Usage

klaw(directory, [options])

Returns a Readable stream that iterates through every file and directory starting with dir as the root. Every read() or data event returns an object with two properties: path and stats. path is the full path of the file and stats is an instance of fs.Stats.

• directory: The directory to recursively walk. Type string.
• options: Readable stream options and the following:
  • queueMethod: Either 'shift' or 'pop'. Type string.
  • pathSorter: Sorting function for Arrays. Type function.

Streams 1 (push) example:

var klaw = require('klaw')

var items = [] // files, directories, symlinks, etc
klaw('/some/dir')
  .on('data', function (item) {
    items.push(item.path)
  })
  .on('end', function () {
    console.dir(items) // => [ ... array of files]
  })

Streams 2 & 3 (pull) example:

var klaw = require('klaw')

var items = [] // files, directories, symlinks, etc
klaw('/some/dir')
  .on('readable', function () {
    var item
    while ((item = this.read())) {
      items.push(item.path)
    }
  })
  .on('end', function () {
    console.dir(items) // => [ ... array of files]
  })

If you're not sure of the differences on Node.js streams 1, 2, 3 then I'd recommend this resource as a good starting point: https://strongloop.com/strongblog/whats-new-io-js-beta-streams3/.

Error Handling

Listen for the error event.

Example:

var klaw = require('klaw')
klaw('/some/dir')
  .on('readable', function () {
    var item
    while ((item = this.read())) {
      // do something with the file
    }
  })
  .on('error', function (err, item) {
    console.log(err.message)
    console.log(item.path) // the file the error occurred on
  })
  .on('end', function () {
    console.dir(items) // => [ ... array of files]
  })

Aggregation / Filtering / Executing Actions (Through Streams)

On many occasions you may want to filter files based upon size, extension, etc. Or you may want to aggregate stats on certain file types. Or maybe you want to perform an action on certain file types.

You should use the module through2 to easily accomplish this.

Install through2:

npm i --save through2

Example (skipping directories):

var klaw = require('klaw')
var through2 = require('through2')

var excludeDirFilter = through2.obj(function (item, enc, next) {
  if (!item.stats.isDirectory()) this.push(item)
  next()
})

var items = [] // files, directories, symlinks, etc
klaw('/some/dir')
  .pipe(excludeDirFilter)
  .on('data', function (item) {
    items.push(item.path)
  })
  .on('end', function () {
    console.dir(items) // => [ ... array of files without directories]
  })

Example (totaling size of PNG files):

var klaw = require('klaw')
var path = require('path')
var through2 = require('through2')

var totalPngsInBytes = 0
var aggregatePngSize = through2.obj(function (item, enc, next) {
  if (path.extname(item.path) === 'png') {
    totalPngsInBytes += item.stats.size
  }
  this.push(item)
  next()
})

klaw('/some/dir')
  .pipe(aggregatePngSize)
  .on('data', function (item) {
    items.push(item.path)
  })
  .on('end', function () {
    console.dir(totalPngsInBytes) // => total of all pngs (bytes)
  })

Example (deleting all .tmp files):

var fs = require('fs')
var klaw = require('klaw')
var through2 = require('through2')

var deleteAction = through2.obj(function (item, enc, next) {
  this.push(item)

  if (path.extname(item.path) === 'tmp') {
    item.deleted = true
    fs.unklink(item.path, next)
  } else {
    item.deleted = false
    next()
  }  
})

var deletedFiles = []
klaw('/some/dir')
  .pipe(deleteAction)
  .on('data', function (item) {
    if (!item.deleted) return
    deletedFiles.push(item.path)
  })
  .on('end', function () {
    console.dir(deletedFiles) // => all deleted files
  })

You can even chain a bunch of these filters and aggregators together. By using multiple pipes.

Example (using multiple filters / aggregators):

klaw('/some/dir')
  .pipe(filterCertainFiles)
  .pipe(deleteSomeOtherFiles)
  .on('end', function () {
    console.log('all done!')
  })

Searching Strategy

Pass in options for queueMethod and pathSorter to affect how the file system is recursively iterated. See the code for more details, it's less than 50 lines :)

License

MIT

Copyright (c) 2015 JP Richardson