Language / Framework: TypeScript
Categories: Readability, Maintainability, Functionality
TSLint Version: 5.17.0

TSLint is a linter for the TypeScript language.

codeclimate-tslint is a Code Climate engine that wraps TSLint. You can run it on your command line using the Code Climate CLI, or on Code Climate's hosted analysis platform.

Enable the Plugin

To enable TSLint analysis on Code Climate's hosted platform, add the following to your .codeclimate.yml configuration file:

    enabled: true
    config: tslint.json

To run TSLint on the command line using the Code Climate CLI:

  1. If you haven't already, install the Code Climate CLI.
  2. Edit your .codeclimate.yml file to enable the plugin (as shown above).
  3. You're ready to analyze! Browse into your project's folder and run codeclimate analyze.

Understand the Plugin

The official TSLint documentation has information about each of the checks the tool performs on your TypeScript code.