eslint-plugin-tslint icon indicating copy to clipboard operation
eslint-plugin-tslint copied to clipboard

:sparkles: A plugin which allows you to run a full instance of TSLint within ESLint

This project has been moved to the TypeScript ESLint organization -> https://typescript-eslint.io


ESLint Plugin TSLint

Travis GitHub license NPM Version NPM Downloads Commitizen friendly semantic-release greenkeeper.io

ESLint plugin wraps a TSLint configuration and lints the whole source using TSLint.

INSTALL

npm i -D eslint-plugin-tslint

USAGE

Configure in your eslint config file:

"plugins": [
    "tslint"
],
"rules": {
    "tslint/config": ["warn", {
        lintFile: '/* path to tslint.json of your project */',
        rules: { /* tslint rules (will be used if `lintFile` is not specified) */ },
        rulesDirectory: [ /* array of paths to directories with rules, e.g. 'node_modules/tslint/lib/rules' (will be used if `lintFile` is not specified) */ ],
        configFile: '/* path to tsconfig.json of your project */',
        compilerOptions: { /* ability to override TypeScript compilers options defined in tsconfig.json */ }
    }],
}

RULES

Plugin contains only single rule tslint/config.

EXAMPLES

TSLint Plugins

  • https://github.com/Glavin001/tslint-clean-code
  • https://github.com/Microsoft/tslint-microsoft-contrib
  • https://github.com/SonarSource/SonarTS
  • https://github.com/ajafff/tslint-consistent-codestyle