Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

filehound

1.17.4 • Public • Published

Filehound

NPM downloads npm Build Status Coverage Status license github-issues stars forks

Flexible and fluent interface for searching the file system

nodei.co

Installation

npm install --save filehound

Demo

Usage

The example below prints all of the files in a directory that have the .json file extension:

const FileHound = require('filehound');
 
const files = FileHound.create()
  .paths('/some/dir')
  .ext('json')
  .find();
 
files.then(console.log);

Documentation

For more examples and API details, see API documentation

Test

npm test

To generate a test coverage report:

npm run coverage

Contributing

  • If you're unsure if a feature would make a good addition, you can always create an issue first.
  • We aim for 100% test coverage. Please write tests for any new functionality or changes.
  • Any API changes should be fully documented.
  • Make sure your code meets our linting standards. Run npm run lint to check your code.
  • Maintain the existing coding style. There are some settings in .jsbeautifyrc to help.
  • Be mindful of others when making suggestions and/or code reviewing.

Install

npm i filehound

DownloadsWeekly Downloads

13,863

Version

1.17.4

License

MIT

Unpacked Size

3.23 MB

Total Files

165

Last publish

Collaborators

  • avatar