# gulp-filesinstream

> A plugin, which prints current files in stream into console with given formatting

Latest version **0.9.3** (published 2015-05-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-filesinstream
pnpm add gulp-filesinstream
yarn add gulp-filesinstream
bun add gulp-filesinstream
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.9.3 |
| Published | 2015-05-28 |
| First published | 2014-11-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10 |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Max Grass |
| Maintainers | maxgrass |
| Keywords | gulpplugin, format, formatting, files, pretty, print |

## Links

- npm: https://www.npmjs.com/package/gulp-filesinstream
- Repository: https://github.com/maxgrass/gulp-filesInStream
- Issues: https://github.com/maxgrass/gulp-filesInStream/issues
- npm.io page: https://npm.io/package/gulp-filesinstream

## Dependencies (4)

- [fs](https://npm.io/package/fs.md) 0.0.2
- [path](https://npm.io/package/path.md) ^0.4.9
- [chalk](https://npm.io/package/chalk.md) ^0.5.1
- [map-stream](https://npm.io/package/map-stream.md) ^0.0.5

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 0.9.3 (latest) — 2015-05-28
- 0.9.2 — 2014-11-20
- 0.9.1 — 2014-11-19
- 0.9.0 — 2014-11-19

## README

# gulp-filesInStream
> A plugin, which prints current files in stream into console with given formatting

## Usage

First, install `gulp-filesInStream` as a development dependency:

```shell
npm install --save-dev gulp-filesinstream
npm install --save-dev chalk
```

Then, add it to your `gulpfile.js`:

```javascript
var filesInStream = require('gulp-filesinstream'),
    chalk = require('chalk');

gulp.task('myTask', function(){
  gulp.src(['file.txt'])
    .pipe(filesInStream(chalk.bgBlue, 'MY TEXT FILE'))
    .pipe(gulp.dest('build/file.txt'));
});
```


## API

gulp-filesInStream can be called:

a. without parameters, so default chalk.white.bold is used

b. with chalk parameter, e.g. chalk.bgRed.bold

c. with chalk AND message prefix, e.g. 'FILE TO BE COMPILED:'


### filesInStream([chalkOptions[, stringMessagePrefix])

#### chalkOptions
Type: `Funtction`

The chalk to print with.

#### stringMessagePrefix
Type: `String`

Message to prefix the file with, e.g. 'FILE TO BE COMPILED:' will produce "FILE TO BE COMPILED: somefile.js"

[Chalk documentation]: https://www.npmjs.org/package/chalk

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