https://github.com/JamesHenry/eslint-plugin-tslint

:sparkles: A plugin which allows you to run a full instance of TSLint within ESLint
https://github.com/JamesHenry/eslint-plugin-tslint

eslint eslint-plugin-tslint plugin tslint typescript

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/JamesHenry/eslint-plugin-tslint
• Owner: JamesHenry
• License: mit
• Archived: true
• Created: 2016-12-28T23:48:16.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2019-01-17T19:18:45.000Z (about 6 years ago)
• Last Synced: 2024-08-02T05:12:23.396Z (6 months ago)
• Topics: eslint, eslint-plugin-tslint, plugin, tslint, typescript
• Language: TypeScript
• Homepage: https://jameshenry.blog
• Size: 222 KB
• Stars: 21
• Watchers: 7
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

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

---

# ESLint Plugin TSLint

[![Travis](https://img.shields.io/travis/JamesHenry/eslint-plugin-tslint.svg?style=flat-square)](https://travis-ci.org/JamesHenry/eslint-plugin-tslint) 

[![GitHub license](https://img.shields.io/npm/l/eslint-plugin-tslint.svg?style=flat-square)](https://github.com/JamesHenry/eslint-plugin-tslint/blob/master/LICENSE) 

[![NPM Version](https://img.shields.io/npm/v/eslint-plugin-tslint.svg?style=flat-square)](https://www.npmjs.com/package/eslint-plugin-tslint) 

[![NPM Downloads](https://img.shields.io/npm/dt/eslint-plugin-tslint.svg?style=flat-square)](https://www.npmjs.com/package/eslint-plugin-tslint) 

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) 

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release) 

[![greenkeeper.io](https://badges.greenkeeper.io/JamesHenry/mongoose-schema-to-typescript-interface.svg?style=flat-square)](https://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

* [unlight/node-package-starter/.eslintrc.js](https://github.com/unlight/node-package-starter/blob/master/.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