https://github.com/werk85/tslint-rules
Organisation wide tslint rules for werk85
https://github.com/werk85/tslint-rules
tslint tslint-rules werk85
Last synced: 10 months ago
JSON representation
Organisation wide tslint rules for werk85
- Host: GitHub
- URL: https://github.com/werk85/tslint-rules
- Owner: werk85
- Created: 2017-01-06T15:43:08.000Z (about 9 years ago)
- Default Branch: develop
- Last Pushed: 2022-06-02T22:42:12.000Z (over 3 years ago)
- Last Synced: 2024-10-30T02:56:24.799Z (about 1 year ago)
- Topics: tslint, tslint-rules, werk85
- Language: TypeScript
- Size: 67.4 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# werk85-tslint-rules [](https://circleci.com/gh/werk85/tslint-rules)
Organisation wide tslint rules for [werk85](https://www.werk85.de/).
## Installation
```
npm install werk85-tslint-rules --save-dev
```
## Usage
### Base Rules
Extend your `tslint.json` configuration via
```json
{
"extends": "werk85-tslint-rules"
}
```
and overwrite rules suited for the current project or use on of the more specific configurations listed below.
The usable rule set includes all standard [tslint-rules](https://palantir.github.io/tslint/rules/) and the
[tslint-eslint-rules](https://github.com/buzinas/tslint-eslint-rules) set.
### Angular 2 Rules
For Angular 2 based project use the `werk85-tslint-rules/lib/tslint-angular2` via
```json
{
"extends": "werk85-tslint-rules/lib/tslint-angular2",
"rules": {
"directive-selector": [
true,
"attribute",
"w85",
"camelCase"
],
"component-selector": [
true,
"element",
"w85",
"kebab-case"
],
"pipe-naming": [
true,
"camelCase",
"w85"
],
}
}
```
**Note:** You have to define the appropriate directive, component and pipe prefix by yourself. Please replace the `"w85"` string by an appropriate shortcut for your project.
This configuration uses the [codelyzer](https://github.com/mgechev/codelyzer) tslint rules and extends the "Base Rules" described above.