<commit_before># grunt-typescript-notify

> Growl notifications for grunt-typescript

Send Growl notifications when [grunt-typescript](https://github.com/k-maru/grunt-typescript) completes a build.

Lets you know if things are good :white_check_mark: or bad :x: without having to check your console (especially useful with grunt-typescript's `watch` option).

See [grunt-notify](https://github.com/dylang/grunt-notify) for the list of supported Growl-like notification apps supported.


## Installing

Clone and link into your project (will be published to __npm__ at a later date).


Once installed, enable it in your `Gruntfile.js`:

```javascript
grunt.loadNpmTasks('grunt-typescript-notify');
```


## Options

These are the default options for the notifications, you can override them in your `Gruntfile.js`:

```javascript
grunt.initConfig({

	'typescript-notify': {
		options: {
			success: {
				title: 'SUCCESS - TypeScript compile',
				message: '<best-guess at project name from package.json>',
				image: '<full path to success image>'
			},
			failed: {
				title: 'FAILED - TypeScript compile',
				message: '<best-guess at project name from package.json>',
				image: '<full path to failed image>'
			}
		}
	}
	
});
```

## Images

Success/failed/error images borrowed from:
https://github.com/karma-runner/karma-growl-reporter

"Thumb" icon from: 
http://www.flaticon.com/<commit_msg>docs(readme): update installation instructions; need prerelease grunt-typescript<commit_after># grunt-typescript-notify

> Growl notifications for grunt-typescript

Send Growl notifications when [grunt-typescript](https://github.com/k-maru/grunt-typescript) completes a build.

Lets you know if things are good :white_check_mark: or bad :x: without having to check your console (especially useful with grunt-typescript's `watch` option).

See [grunt-notify](https://github.com/dylang/grunt-notify) for the list of supported Growl-like notification apps supported.


## Installing

```bash
$ npm install grunt-typescript-notify --save-dev
```


NOTE: `grunt-typescript-notify` currently needs a pre-release version of `grunt-typescript` to work properly:

```javascript
// package.json
{
	"dependencies": {
		"grunt-typescript": "git://github.com/Coridyn/grunt-typescript#feat/grunt-raise-success-event"
		// ...
	}
}
```


Once installed, enable it in your `Gruntfile.js`:

```javascript
grunt.loadNpmTasks('grunt-typescript-notify');
```



## Options

These are the default options for the notifications, you can override them in your `Gruntfile.js`:

```javascript
grunt.initConfig({

	'typescript-notify': {
		options: {
			success: {
				title: 'SUCCESS - TypeScript compile',
				message: '<best-guess at project name from package.json>',
				image: '<full path to success image>'
			},
			failed: {
				title: 'FAILED - TypeScript compile',
				message: '<best-guess at project name from package.json>',
				image: '<full path to failed image>'
			}
		}
	}
	
});
```

## Images

Success/failed/error images borrowed from:
https://github.com/karma-runner/karma-growl-reporter

"Thumb" icon from: 
http://www.flaticon.com/
{'fraction_non_alphanumeric': 0.12567956507834985, 'fraction_numerical': 0.0, 'mean_word_length': 4.196013289036545, 'pattern_counts': {'":': 2, '<': 11, '<?xml version=': 0, '>': 13, 'https://': 6, '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': '388485', 'n_tokens_mistral': 1062, 'n_tokens_neox': 966, 'n_words': 290}