# detect-repo-test-files

> Scans a repository directory, searching for a test files

Latest version **1.2.2** (published 2018-09-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install detect-repo-test-files
pnpm add detect-repo-test-files
yarn add detect-repo-test-files
bun add detect-repo-test-files
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.2 |
| Published | 2018-09-30 |
| First published | 2016-09-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 9.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | IndigoUnited |
| Maintainers | satazor |
| Keywords | test files, tests, test, scan, repository, repo |

## Links

- npm: https://www.npmjs.com/package/detect-repo-test-files
- Repository: https://github.com/IndigoUnited/node-detect-repo-test-files
- Homepage: https://github.com/IndigoUnited/node-detect-repo-test-files#readme
- Issues: https://github.com/IndigoUnited/node-detect-repo-test-files/issues/
- npm.io page: https://npm.io/package/detect-repo-test-files

## Dependencies (1)

- [globby](https://npm.io/package/globby.md) ^8.0.1

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 1.2.2 (latest) — 2018-09-30
- 1.2.1 — 2018-09-30
- 1.2.0 — 2018-09-25
- 1.1.0 — 2017-03-06
- 1.0.0 — 2016-09-16

## README

# detect-repo-test-files

[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Dependency status][david-dm-image]][david-dm-url] [![Dev Dependency status][david-dm-dev-image]][david-dm-dev-url] [![Greenkeeper badge][greenkeeper-image]][greenkeeper-url]

[npm-url]:https://npmjs.org/package/detect-repo-test-files
[downloads-image]:http://img.shields.io/npm/dm/detect-repo-test-files.svg
[npm-image]:http://img.shields.io/npm/v/detect-repo-test-files.svg
[travis-url]:https://travis-ci.org/IndigoUnited/node-detect-repo-test-files
[travis-image]:http://img.shields.io/travis/IndigoUnited/node-detect-repo-test-files/master.svg
[coveralls-url]:https://coveralls.io/r/IndigoUnited/node-detect-repo-test-files
[coveralls-image]:https://img.shields.io/coveralls/IndigoUnited/node-detect-repo-test-files/master.svg
[david-dm-url]:https://david-dm.org/IndigoUnited/node-detect-repo-test-files
[david-dm-image]:https://img.shields.io/david/IndigoUnited/node-detect-repo-test-files.svg
[david-dm-dev-url]:https://david-dm.org/IndigoUnited/node-detect-repo-test-files?type=dev
[david-dm-dev-image]:https://img.shields.io/david/dev/IndigoUnited/node-detect-repo-test-files.svg
[greenkeeper-image]:https://badges.greenkeeper.io/IndigoUnited/node-detect-repo-test-files.svg
[greenkeeper-url]:https://greenkeeper.io/

Scans a repository directory, searching for a test files.

All files present in test folders will be returned, including non-javascript files. You may filter those files afterwards with `Array#filter`.


## Installation

`$ npm install detect-repo-test-files`


## Usage

`detectRepoTestFiles(dir) -> Promise`

```js
const detectRepoTestFiles = require('detect-repo-test-files');

detectRepoTestFiles('./some-repository-directory')
.then((files) => {
    console.log(`detected ${files.length} test file(s)`);
    console.log(files);
});
```


## Tests

`$ npm test`   
`$ npm test-cov` to get coverage report


## License

Released under the [MIT License](http://www.opensource.org/licenses/mit-license.php).

---
_Source: https://npm.io/package/detect-repo-test-files · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
