gulp-tslint-stylish/README.md

gulp-tslint-stylish
===================

![Build Status](https://travis-ci.org/adamfitzpatrick/tslint-stylish.svg?branch=gulp-tslint-develop)

*Please be aware that this package will be superceded by (tslint-stylish)[https://www.npmjs.com/package/tslint-stylish]
in the near future.*

Typescript lint reporter for gulp-tslint along the lines of jshint-stylish.  A special thanks to
[Sindre Sorhus](https://github.com/sindresorhus) for the reporter design, and to
[Panu Horsmalahti](https://github.com/panuhorsmalahti) for creating
[gulp-tslint](https://github.com/panuhorsmalahti/gulp-tslint).

Installation
------------
Note that this is designed to accept output from gulp-tslint, which must be installed separately.
To install this package:

```
npm install gulp-tslint-stylish
```

Usage
-----

```
var gulp = require('gulp');
var tslint = require('gulp-tslint');
var stylish = require('gulp-tslint-stylish');

gulp.task('lint', function () {
    gulp.src('SourceFiles.ts')
      .pipe(tslint())
      .pipe(tslint.report(stylish, {
        emitError: false,
        sort: true,
        bell: true,
        fullPath: true
      }));
```

Options
-------
- `sort`
	- Default is `true`
	- When true, failures are sorted by line number.
- `bell`
    - Default is `true`
    - When true, emits the system bell with report.
- `fullPath`
    - Default is `true`
    - When true, shows full file path name.  When false, shows only the filename.
    - Contribution courtesy of [Sagar Vadodaria](https://github.com/sagarvadodaria)