-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
57f5fbf
commit a2410bc
Showing
1 changed file
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# tslint-config-uxpin | ||
|
||
UXPin recommended TSLint configuration. | ||
|
||
## Installation | ||
|
||
Install TSLint and `tslint-config-uxpin`: | ||
|
||
yarn add --dev tslint tslint-config-uxpin | ||
|
||
or | ||
|
||
npm install tslint tslint-config-uxpin --save-dev | ||
|
||
Then create a `tslint.json` file in the root directory of your package, with the following contents: | ||
|
||
```json | ||
{ | ||
"extends": "tslint-config-uxpin" | ||
} | ||
``` | ||
|
||
## Customization | ||
|
||
In some cases, default configuration of the `tslint-config-uxpin` may not fit specifics of your projects. In most cases it's unrecommended but still possible to override the default configuration: | ||
|
||
```json | ||
{ | ||
"extends": "tslint-config-uxpin", | ||
"rules": { | ||
"no-default-export": false, | ||
"match-default-export-name": true | ||
} | ||
} | ||
``` |