README.md

ESLint Plugin TSLint

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

Installation

yarn add -D @typescript-eslint/eslint-plugin-tslint

Usage

Configure in your ESLint config file:

{
  "plugins": [
    "@typescript-eslint/tslint"
  ],
  "parserOptions": {
      "project": "tsconfig.json",
  },
  "rules": {
    "@typescript-eslint/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)
      ]
    }],
  }
}

Note: The ability to automatically fix problems with --fix is unavailable for TSLint rules loaded with this plugin.

Rules

Plugin contains only single rule @typescript-eslint/tslint/config.

Examples

• unlight/node-package-starter/.eslintrc.js

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

Contributing

See the contributing guide here