Package Exports

tslint
tslint/bin/tslint
tslint/lib
tslint/lib/configs/all
tslint/lib/configs/latest
tslint/lib/configuration
tslint/lib/enableDisableRules
tslint/lib/error
tslint/lib/index
tslint/lib/language/formatter/abstractFormatter
tslint/lib/language/rule/abstractRule
tslint/lib/language/rule/rule
tslint/lib/rules
tslint/lib/rules/noUnusedExpressionRule
tslint/lib/runner
tslint/lib/tslint-cli
tslint/lib/tslint-cli.js
tslint/lib/utils
tslint/package.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tslint) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

TSLint

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:

custom lint rules
custom formatters (failure reporters)
inline disabling and enabling of rules
configuration presets (tslint:latest, tslint-react, etc.) & composition
automatic fixing of formatting & style violations
integration with msbuild, grunt, gulp, atom, eclipse, emacs, sublime, vim, visual studio, vscode, webstorm, and more

Installation & Usage

Refer to the full installation & usage documentation on the TSLint website.

There, you'll find information about

Custom Rules

Custom rule sets from Palantir

tslint-react - Lint rules related to React & JSX.
tslint-blueprint - Lint rules to enforce best practices with blueprintjs libraries

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 custom rules that others have developed. The repos below are a good source of custom rules:

ESLint rules for TSLint - Improve your TSLint with the missing ESLint Rules
tslint-microsoft-contrib - A set of TSLint rules used on some Microsoft projects
codelyzer - A set of tslint rules for static code analysis of Angular TypeScript projects
vrsource-tslint-rules
tslint-immutable - TSLint rules to disable mutation in TypeScript
tslint-consistent-codestyle - TSLint rules to enforce consistent code style in TypeScript

Development

Requirements:

node v7
yarn v0.18

Quick Start

git clone git@github.com:palantir/tslint.git --config core.autocrlf=input --config core.eol=lf
yarn install
yarn compile
yarn test

Creating a new release

Bump the version number in package.json and src/tslintMulti.ts
Add release notes in CHANGELOG.md
yarn verify to build the latest sources
Commit with message Prepare release <version>
Run npm publish
Create a git tag for the new release and push it (see existing tags here)