An open API service indexing awesome lists of open source software.

https://github.com/tkqubo/codeclimate-tslint

Code Climate TSLint-Engine
https://github.com/tkqubo/codeclimate-tslint

climate-cli climate-engine climate-tslint-engine codeclimate tslint typescript

Last synced: 28 days ago
JSON representation

Code Climate TSLint-Engine

Awesome Lists containing this project

README

          

# Code Climate TSLint-Engine

[![CircleCI](https://img.shields.io/circleci/project/tkqubo/codeclimate-tslint.svg)](https://circleci.com/gh/tkqubo/codeclimate-tslint)
[![Code Climate](https://codeclimate.com/github/tkqubo/codeclimate-tslint/badges/gpa.svg)](https://codeclimate.com/github/tkqubo/codeclimate-tslint)
[![Code Climate](https://img.shields.io/codeclimate/coverage/github/tkqubo/codeclimate-tslint.svg)](https://codeclimate.com/github/tkqubo/codeclimate-tslint/coverage)
![David](https://david-dm.org/tkqubo/codeclimate-tslint.svg)
[![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)

`codeclimate-tslint` is a Code Climate engine that wraps [tslint](http://palantir.github.io/tslint/). You can run it on your command line using the Code Climate CLI, or on Code Climate's hosted analysis platform.

`TSLint` is a linter for the TypeScript language.

### Installation

1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate).
2. Run `codeclimate engines:enable tslint`. This command both installs the engine and enables it in your `.codeclimate.yml` file.
3. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`.

### Need help?

For help with `tslint`, [check out their documentation](http://palantir.github.io/tslint/).

If you're running into a Code Climate issue, first look over this project's [GitHub Issues](https://github.com/tkqubo/codeclimate-tslint/issues), as your question may have already been covered.