TSLint Config Standard Plus :green_apple:

   

> A TSLint config for JavaScript Standard Style with a plus of useful rules.

__TSLint Config Standard Plus__ contains a JavaScript Standard Style rules as well as a set of additional rules that will help you with syntactic & semantic checks of your TypeScript code in development.

Features

- Typescript Standard Style by StandardJS rules set.
- Clean Code rules set. __(plus)__
- TSLint-ESLint additional rules set. __(plus)__
- no-circular-imports rule. __(plus)__
- Small because only exports a tslint.json.
- VS Code User Workspace pre-configured and ready to use.

$3

Optional tslint config (tslint.legacy.json) that extends from default tslint.json but with additional rules overwritten:

- Enforce consistent spaces like the default config.
- Enforce "double" quotes instead of 'single' ones.
- Enforce 4 space indentation instead of 2.

Rules

This repo exists thanks to these __awesome__ TSLint config projects listed below :tada:

- :1st_place_medal: standardjs — inspiration
- :1st_place_medal: dcl-tslint-config-standard — current fork
- :1st_place_medal: tslint-config-standard — dcl-tslint fork
- :medal_sports: tslint-clean-code — __current dependency__
- :medal_sports: tslint-eslint-rules — __current dependency__
- :medal_sports: tslint-no-circular-imports — __current dependency__

🚀 See all rules in tslint.json file and examples at Printd or Hyperapp Starter source code.

Formatter

Many of the rules set include formatting feature built-in. This repository contains a VS Code User Workspace pre-configured that you can use in order to gain all rule sets benefits just saving your files (ctrl/cmd + S).

For more details, take a look at .vscode directory.

Install

Yarn

``sh
yarn add tslint-config-standard-plus --dev
`

NPM

`sh
npm install tslint-config-standard-plus --save-dev
`

Usage

Setup your tslint.json in your project as follow:

$3

`json
{
"extends": "tslint-config-standard-plus"
}
`

$3

`json
{
"extends": "tslint-config-standard-plus/tslint.legacy"
}
`

$3

To overwrite some specific rules add "rules" section after "extends" in your tslint.json file.

`json
{
"extends": "tslint-config-standard-plus",

"rules": {
"no-any": false
}
}
`

$3

- Add "strict": true to your tsconfig.json to enables all strict type checking options.
- Add "noUnusedLocals": true & "noUnusedParameters": true to your tsconfig` - tslint no-unused-variable rule doesn't report warnings any more?
- Read Microsoft announce about deprecation of vscode-tslint

Contributions

Feel free to send some Pull request or issue.

License

MIT license

© 2018-present Jose Quintana