Awesome
TSLint Config Standard Plus :green_apple:
A TSLint config for JavaScript Standard Style with a plus of useful rules.
⚠️ TSLint is deprecated but not this repository for "now". More details at https://github.com/palantir/tslint.
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.
Config Standard Plus Legacy
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 add tslint-config-standard-plus --dev
npm install tslint-config-standard-plus --save-dev
Usage
Setup your tslint.json
in your project as follow:
Config Standard Plus (default)
{
"extends": "tslint-config-standard-plus"
}
Config Standard Plus Legacy (optional)
{
"extends": "tslint-config-standard-plus/tslint.legacy"
}
Overwrite rules
To overwrite some specific rules add "rules"
section after "extends"
in your tslint.json
file.
{
"extends": "tslint-config-standard-plus",
"rules": {
"no-any": false
}
}
Recommendations
- Add
"strict": true
to yourtsconfig.json
to enables all strict type checking options. - Add
"noUnusedLocals": true
&"noUnusedParameters": true
to yourtsconfig
- 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