Skip to content

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
adidahiya authored Aug 16, 2016
1 parent 81890b6 commit b12b954
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@
TSLint
======

An extensible linter for the TypeScript language.
An extensible linter for the [TypeScript language](https://github.com/Microsoft/TypeScript).

Supports:
TSLint supports:

- custom rules
- custom formatters
- custom lint rules
- custom formatters (failure reporters)
- inline disabling / enabling of rules
- configuration presets (`tslint:latest`, `tslint-react`, etc.) & composition
- integration with [msbuild](https://github.com/joshuakgoldberg/tslint.msbuild), [grunt](https://github.com/palantir/grunt-tslint), [gulp](https://github.com/panuhorsmalahti/gulp-tslint), [atom](https://github.com/AtomLinter/linter-tslint), [eclipse](https://github.com/palantir/eclipse-tslint), [emacs](http://flycheck.org), [sublime](https://packagecontrol.io/packages/SublimeLinter-contrib-tslint), [vim](https://github.com/scrooloose/syntastic), [visual studio](https://visualstudiogallery.msdn.microsoft.com/6edc26d4-47d8-4987-82ee-7c820d79be1d), [vscode](https://marketplace.visualstudio.com/items?itemName=eg2.tslint), [webstorm](https://www.jetbrains.com/webstorm/help/tslint.html), and more

Table of Contents
Expand Down Expand Up @@ -248,6 +249,20 @@ Core Rules
[See the TSLint website for a list of core rules included in the `tslint` package.]
(http://palantir.github.io/tslint/rules/)

Core Formatters
-----

Formatters are used to format the results of the linter before outputting it to stdout or
the configured output file. The core formatters are:

- __prose__: human readable (default)
- __json__: machine readable
- __verbose__: human readable (includes rule names)
- __pmd__
- __msbuild__
- __checkstyle__
- __vso__

Rule Flags
-----
<sup>[back to ToC &uarr;](#table-of-contents)</sup>
Expand Down

0 comments on commit b12b954

Please sign in to comment.