https://github.com/ngryman/gulp-say

Text To Speech errors for gulp.
https://github.com/ngryman/gulp-say

Last synced: about 1 month ago
JSON representation

Text To Speech errors for gulp.

• Host: GitHub
• URL: https://github.com/ngryman/gulp-say
• Owner: ngryman
• Created: 2016-01-16T13:39:08.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-10-14T23:27:04.000Z (about 7 years ago)
• Last Synced: 2024-09-24T02:19:58.499Z (about 2 months ago)
• Language: JavaScript
• Size: 10.7 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# gulp-say [![npm][npm-image]][npm-url] [![travis][travis-image]][travis-url]

[npm-image]: https://img.shields.io/npm/v/gulp-say.svg?style=flat

[npm-url]: https://npmjs.org/package/gulp-say

[travis-image]: https://img.shields.io/travis/ngryman/gulp-say.svg?style=flat

[travis-url]: https://travis-ci.org/ngryman/gulp-say

> Text To Speech errors for gulp.

If you are tired to switch to the terminal to see error details, or visual notifications

annoys you, well, try our new assistant here.

`gulp-say` will try to parse any `gulp` error and read it to you using your system *Text To Speech*

engine.

**Windows is not supported yet. Any pull request is welcomed.**

## Install

```bash

npm install --save-dev gulp-say

```

## Usage

```javascript

const say = require('gulp-say');

gulp.task('copy', () => {

  return gulp.src('./assets/**')

    .on('error', say({ voice: 'Alice' }))

    .pipe(gulp.dest('dist/'));

});

```

## API

#### `say([opts])`

The following options are available:

 - **`voice`**: *(`string`)*, depending on your `tts` engine, it will use the given voice.

 - **`phrase`**: *(`function`)*, overrides the generated output text.

 - **`speak`**: *(`function`)*, overrides the `tts` engine call.

## License

MIT © [Nicolas Gryman](http://ngryman.sh)