https://github.com/nspragg/filehound

Flexible and fluent interface for searching the file system
https://github.com/nspragg/filehound

file filesystem fluent-interface promise

Last synced: about 1 month ago
JSON representation

Flexible and fluent interface for searching the file system

• Host: GitHub
• URL: https://github.com/nspragg/filehound
• Owner: nspragg
• License: mit
• Created: 2016-03-04T14:02:53.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2022-06-26T09:10:05.000Z (over 2 years ago)
• Last Synced: 2024-08-01T08:10:35.177Z (4 months ago)
• Topics: file, filesystem, fluent-interface, promise
• Language: JavaScript
• Homepage:
• Size: 1.03 MB
• Stars: 222
• Watchers: 6
• Forks: 16
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-nodejs-cn - filehound - 灵活、流畅的用于文件系统搜索的接口 (包 / 文件系统)
• awesome-nodejs - filehound - Flexible and fluent interface for searching the file system.  (Repository / Filesystem)
• awesome-nodejs-cn - filehound - **star:222** 灵活流畅的文件系统搜索界面 (包 / 文件系统)
• awesome-nodejs - filehound - Flexible and fluent interface for searching the file system. (Packages / Filesystem)
• awesome-nodejs - filehound - Flexible and fluent interface for searching the file system - ★ 131 (Filesystem)
• awesome-node - filehound - Flexible and fluent interface for searching the file system. (Packages / Filesystem)
• awesome-nodejs-cn - filehound - 用于文件系统搜索的灵活流畅的接口. (目录 / 文件系统)

README

        
# Filehound

[![NPM downloads](https://img.shields.io/npm/dm/filehound.svg?style=flat)](https://npmjs.org/package/filehound)

![npm](https://img.shields.io/npm/v/filehound.svg)

[![Build Status](https://travis-ci.org/nspragg/filehound.svg)](https://travis-ci.org/nspragg/filehound) [![Coverage Status](https://coveralls.io/repos/github/nspragg/filehound/badge.svg?branch=master)](https://coveralls.io/github/nspragg/filehound?branch=master)

 ![license](https://img.shields.io/badge/license-MIT-blue.svg) 

![github-issues](https://img.shields.io/github/issues/nspragg/filehound.svg)

![stars](https://img.shields.io/github/stars/nspragg/filehound.svg)

![forks](https://img.shields.io/github/forks/nspragg/filehound.svg)

> Flexible and fluent interface for searching the file system

![nodei.co](https://nodei.co/npm/filehound.png?downloads=true&downloadRank=true&stars=true)

## Installation

```

npm install --save filehound

```

## Demo



## Usage

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

```js

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](https://nspragg.github.io/filehound/)

## 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](https://github.com/nspragg/filehound/issues/new/choose) first.

* We aim for high 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.