https://github.com/typescript-eslint/eslint-plugin-tslint
ESLint plugin that wraps a TSLint configuration and lints the whole source using TSLint
https://github.com/typescript-eslint/eslint-plugin-tslint
Last synced: 8 months ago
JSON representation
ESLint plugin that wraps a TSLint configuration and lints the whole source using TSLint
- Host: GitHub
- URL: https://github.com/typescript-eslint/eslint-plugin-tslint
- Owner: typescript-eslint
- License: mit
- Created: 2024-02-04T14:49:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-04T15:35:03.000Z (almost 2 years ago)
- Last Synced: 2025-03-23T06:11:18.336Z (9 months ago)
- Language: TypeScript
- Size: 1.35 MB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# `@typescript-eslint/eslint-plugin-tslint`
> ESLint plugin that wraps a TSLint configuration and lints the whole source using TSLint.
[](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin-tslint)
[](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin-tslint)
> ❌ **Per [What About TSLint?](https://typescript-eslint.io/lintingtroubleshooting/TSLint.mdx), we highly recommend migrating off TSLint.**
> See [typescript-eslint.io](https://typescript-eslint.io) for general documentation on typescript-eslint, the tooling that allows you to run ESLint and Prettier on TypeScript code.
## Installation
```sh
yarn add -D @typescript-eslint/eslint-plugin-tslint
```
## Usage
Configure in your ESLint config file:
```js
{
"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
This plugin contains only a single rule: `@typescript-eslint/tslint/config`.