https://github.com/adamfitzpatrick/tslint-stylish

Typescript lint reporter for gulp-tslint along the lines of jshint-stylish.
https://github.com/adamfitzpatrick/tslint-stylish

featured grunt gulp gulp-tslint tslint typescript

Last synced: about 1 month ago
JSON representation

Typescript lint reporter for gulp-tslint along the lines of jshint-stylish.

• Host: GitHub
• URL: https://github.com/adamfitzpatrick/tslint-stylish
• Owner: adamfitzpatrick
• Created: 2015-04-11T05:05:55.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2020-07-15T20:14:07.000Z (over 4 years ago)
• Last Synced: 2024-12-09T00:15:43.728Z (about 1 month ago)
• Topics: featured, grunt, gulp, gulp-tslint, tslint, typescript
• Language: TypeScript
• Size: 111 KB
• Stars: 9
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
tslint-stylish

===================

![Dependencies](https://david-dm.org/adamfitzpatrick/tslint-stylish.svg)

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

This package has been deprecated.  The folks over at Palantir have added a stylish formatter to the list of core

formatters for tslint which provides essentially the same output as this one.

Typescript lint reporter for tslint and gulp-tslint along the lines of jshint-stylish.  This formatter can be implemented

easily using the original tslint package, as well as gulp-tslint, grunt-tslint and webpack.

To everyone who downloaded this package: This was my first attempt at an npm package as a brand new software developer.

Thank you for downloading this package and gulp-tslint-stylish more than 215,000 times - more than I ever imagined

possible.

Thank you 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 tslint and gulp-tslint, which must be installed separately.

To install this package:

```

npm install tslint-stylish

```

Usage

-----

Tslint

- Install Tslint & tslint-stylish:

```

npm install tslint

npm install tslint-stylish

```

- Apply as named formatter:

```

tslint  -s node_modules/tslint-stylish -t stylish

```

Gulp

```

var gulp = require('gulp');

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

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

gulp.task('lint', function () {

    gulp.src('SourceFiles.ts')

      .pipe(tslint())

      .pipe(tslint.report(stylish, {

        emitError: false,

        sort: true,

        bell: 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, full path to file is included with report.  When false, only the filename is included.

    - Contribution courtesy of [Sagar Vadodaria](https://github.com/sagarvadodaria)