andy-ms / tslint

An extensible linter for the TypeScript language.

Home Page:

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

NPM version Downloads Circle CI


TSLint is an extensible static analysis tool that checks TypeScript code for readability, maintainability, and functionality errors. It is widely supported across modern editors & build systems and can be customized with your own lint rules, configurations, and formatters.

TSLint supports:

Installation & Usage

Please refer to the full installation & usage documentation on the TSLint website. There, you'll find information about

Custom Rules & Plugins

Custom rule sets from Palantir

Custom rule sets from the community

If we don't have all the rules you're looking for, you can either write your own custom rules or use rules implementations developed by the community. The repos below are a good source of custom rules:



  • node v7+
  • yarn v1.0+

Quick Start

git clone --config core.autocrlf=input --config core.eol=lf
yarn compile
yarn test

Creating a new release

  1. Bump the version number in package.json and src/linter.ts
  2. Add release notes in
    • Use ./scripts/generate-changelog.js (after building it with tsc -p scripts) to generate the changelog diff. This script expects a personal access token to exist at ~/github_token.txt with "repo" permissions.
  3. Commit with message Prepare release <version>
  4. Push your branch to GitHub and make a PR
  5. Once your PR is merged, wait for the tests to pass on CircleCI for develop
  6. Create a "Release" on GitHub with the proper tag version and notes from the changelog.
    • The tag should be identical to the version in package.json
  7. Run yarn run publish:local


An extensible linter for the TypeScript language.

License:Apache License 2.0


Language:TypeScript 99.6%Language:JavaScript 0.3%Language:Shell 0.1%Language:Batchfile 0.0%