<commit_before>[![npm](https://img.shields.io/npm/v/start-files.svg?style=flat-square)](https://www.npmjs.com/package/start-files)
[![travis](http://img.shields.io/travis/start-runner/files.svg?style=flat-square)](https://travis-ci.org/start-runner/files)
[![deps](https://img.shields.io/gemnasium/start-runner/files.svg?style=flat-square)](https://gemnasium.com/start-runner/files)

Files task for [Start](https://github.com/start-runner/start).

## Install

```
npm i -S start-files
```

## Usage

Task provides an array of found files.

```js
// tasks/index.js
import start from 'start';
import logger from 'start-simple-logger';
import files from 'start-files';
import eslint from 'start-eslint';

export function lint() {
    return start(logger())(
        files('lib/**/*.js'),
        eslint()
    );
}
```

```js
// package.json
"scripts": {
  "task": "babel-node node_modules/.bin/start tasks/",
  "lint": "npm run task lint"
}
```

## Arguments

`files(glob, options)`

* `glob` – [globby patterns](https://github.com/sindresorhus/globby#patterns)
* `options` – [node-glob options](https://github.com/isaacs/node-glob#options), `{ realpath: true, ignore: 'node_modules/**' }` by default<commit_msg>:pencil: update README<commit_after>[![npm](https://img.shields.io/npm/v/start-files.svg?style=flat-square)](https://www.npmjs.com/package/start-files)
[![travis](http://img.shields.io/travis/start-runner/files.svg?style=flat-square)](https://travis-ci.org/start-runner/files)
[![coverage](https://img.shields.io/codecov/c/github/start-runner/files.svg?style=flat-square)](https://codecov.io/github/start-runner/files)
[![deps](https://img.shields.io/gemnasium/start-runner/files.svg?style=flat-square)](https://gemnasium.com/start-runner/files)
[![gitter](https://img.shields.io/badge/gitter-join_chat_%E2%86%92-00d06f.svg?style=flat-square)](https://gitter.im/start-runner/start)

Files task for [Start](https://github.com/start-runner/start).

## Install

```
npm i -S start-files
```

## Usage

```js
import start from 'start';
import logger from 'start-simple-logger';
import files from 'start-files';
import eslint from 'start-eslint';

export function lint() {
    return start(logger())(
        files('lib/**/*.js'),
        eslint()
    );
}
```

Task provides an array of found files, see [documentation](https://github.com/start-runner/start#readme) for details.

## Arguments

`files(glob, options)`

* `glob` – [globby patterns](https://github.com/sindresorhus/globby#patterns)
* `options` – [node-glob options](https://github.com/isaacs/node-glob#options), `{ realpath: true, ignore: 'node_modules/**' }` by default
{'fraction_non_alphanumeric': 0.2057597574838954, 'fraction_numerical': 0.0034103827207275484, 'mean_word_length': 4.751633986928105, 'pattern_counts': {'":': 3, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 21, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6282465', 'n_tokens_mistral': 973, 'n_tokens_neox': 935, 'n_words': 142}