1 | <h1 align="center">ESLint Plugin TSLint</h1>
|
2 |
|
3 | <p align="center">ESLint plugin wraps a TSLint configuration and lints the whole source using TSLint.</p>
|
4 |
|
5 | <p align="center">
|
6 | <img src="https://github.com/typescript-eslint/typescript-eslint/workflows/CI/badge.svg" alt="CI" />
|
7 | <a href="https://www.npmjs.com/package/@typescript-eslint/eslint-plugin-tslint"><img src="https://img.shields.io/npm/v/@typescript-eslint/eslint-plugin-tslint.svg?style=flat-square" alt="NPM Version" /></a>
|
8 | <a href="https://www.npmjs.com/package/@typescript-eslint/eslint-plugin-tslint"><img src="https://img.shields.io/npm/dm/@typescript-eslint/eslint-plugin-tslint.svg?style=flat-square" alt="NPM Downloads" /></a>
|
9 | </p>
|
10 |
|
11 | ## Installation
|
12 |
|
13 | ```sh
|
14 | yarn add -D @typescript-eslint/eslint-plugin-tslint
|
15 | ```
|
16 |
|
17 | ## Usage
|
18 |
|
19 | Configure in your ESLint config file:
|
20 |
|
21 | ```js
|
22 | {
|
23 | "plugins": [
|
24 | "@typescript-eslint/tslint"
|
25 | ],
|
26 | "parserOptions": {
|
27 | "project": "tsconfig.json",
|
28 | },
|
29 | "rules": {
|
30 | "@typescript-eslint/tslint/config": ["warn", {
|
31 | "lintFile": "", // path to tslint.json of your project
|
32 | "rules": {
|
33 | // tslint rules (will be used if `lintFile` is not specified)
|
34 | },
|
35 | "rulesDirectory": [
|
36 | // array of paths to directories with rules, e.g. 'node_modules/tslint/lib/rules' (will be used if `lintFile` is not specified)
|
37 | ]
|
38 | }],
|
39 | }
|
40 | }
|
41 | ```
|
42 |
|
43 | **Note:** The ability to automatically fix problems with `--fix` is unavailable for TSLint rules loaded with this plugin.
|
44 |
|
45 | ## Rules
|
46 |
|
47 | Plugin contains only single rule `@typescript-eslint/tslint/config`.
|
48 |
|
49 | ## Examples
|
50 |
|
51 | - [`unlight/node-package-starter/.eslintrc.js`](https://github.com/unlight/node-package-starter/blob/master/.eslintrc.js)
|
52 |
|
53 | ### TSLint Plugins
|
54 |
|
55 | - https://github.com/Glavin001/tslint-clean-code
|
56 | - https://github.com/Microsoft/tslint-microsoft-contrib
|
57 | - https://github.com/SonarSource/SonarTS
|
58 | - https://github.com/ajafff/tslint-consistent-codestyle
|
59 |
|
60 | ## Contributing
|
61 |
|
62 | [See the contributing guide here](../../CONTRIBUTING.md)
|