Home

Awesome

Pronto runner for TSLint (using tslint from npm)

forked from doits/pronto-eslint_npm

Gem Version Build Status Code Climate Issue Count Dependency Status Coverage Status Inline docs

Pronto runner for TSlint, pluggable linting utility for TypeScript. What is Pronto?

Uses official tslint executable installed by npm.

Prerequisites

You'll need to install tslint by yourself with npm. If tslint is in your PATH, everything will simply work, otherwise you have to provide pronto-tslint-npm your custom executable path (see below).

Installation

First, ensure you have node with npm installed, then install tslint using the following command in your terminal:

npm install -g tslint

Second, ensure you have pronto installed, if you have not already:

gem install pronto

Finally, install this gem, using the following command

gem install pronto-tslint_npm

Configuration of TSLint

Configuring TSLint via tslint.json will work just fine with pronto-eslint_npm.

<!-- [tslintignore]: http://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories -->

Configuration of TSLintNPM

pronto-tslint-npm can be configured by placing a .pronto_tslint_npm.yml inside the directory where pronto is run.

Following options are available:

OptionMeaningDefault
tslint_executableTSLint executable to call.tslint (calls tslint in PATH)
files_to_lintWhat files to lint. Absolute path of offending file will be matched against this Regexp.(\.ts)$

Example configuration to call custom eslint executable and only lint files ending with .my_custom_extension:

# .pronto_tslint_npm.yml
tslint_executable: '/my/custom/node/path/.bin/tslint'
files_to_lint: '\.my_custom_extension$'