Skip to content

thomas-lebeau/zut

Repository files navigation

zut!

We all swear at our computers when things go sideways. Now it's time for payback!
i.e.: Makes your computer say random stuffs to you.

Install

$ npm install --save zut

Requirements

zut! uses OS specific dependancies.

  • It works on MacOS using say. Configure it in the System Preference
  • It works on Linux using Festival

Usage

var zut = require('zut');

zut();
//=> 📢 probably something stupid

Example

With gulp

...
var zut = require('zut');

gulp.task('sass', function() {
	return gulp.src('style.scss')
		.pipe(plumber({errorHandler: zut}))
		.pipe(sass.sync()).on('error', sass.logError)
		.pipe(gulp.dest('.'));
});
//=> 📢 "Oooh Snap!"

Custom Messages

var zut = require('zut');

zut({voice: 'Junior', messages: ['foo', 'bar', 'baz']});
//=> 📢 "bar" (randomly)

API

zut([options])

options

voice

Type: String
Default: System Default

messages

Type: String, Array or Object

filters

Type: String, Array

Restrict to one or more category.
For now only one category is available: errors.

Contribute

Contributions welcome! You may want to check issue #1 but any other PR will be considered.

FAQ

What is 'zut'?

"Zut!" is the French for "Damn!"

License

MIT © Thomas Lebeau

About

Makes your computer shout random stuffs at you.

Resources

License

Stars

Watchers

Forks

Packages

No packages published