Skip to content

Commit 3374be5

Browse files
committed
upated readme and package.json
1 parent 6b7878a commit 3374be5

File tree

2 files changed

+21
-3
lines changed

2 files changed

+21
-3
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Standard eslint rules
1414
Install peer denpendencies as required
1515
``` npm install eslint-plugin-import eslint-plugin-jest eslint-plugin-react -D ```
1616

17+
## Setup
18+
1719
Extend @fourjs/eslint-config-tn to apply rules.
1820

1921
```
@@ -36,3 +38,15 @@ Override rules by adding rules as mentioned below
3638
...
3739
}
3840
}
41+
```
42+
43+
Provides different type of linting's which can be extented
44+
```
45+
@fourjs/eslint-config-tn -> This provides lint rules for your Javascript code
46+
47+
@fourjs/eslint-config-tn/jest -> This provides lint rule for jest unit tests
48+
49+
@fourjs/eslint-config-tn/react -> This provides lint rule for React code
50+
51+
@fourjs/eslint-config-tn/all -> This combines all rules for Javascript, Jest and React
52+
```

package.json

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
{
22
"name": "@fourjs/eslint-config-tn",
3-
"version": "2.0.0",
3+
"version": "4.1.0",
44
"description": "Standard eslint rules",
55
"scripts": {
66
"test": "npm run lint",
77
"lint": "eslint **/*.js"
88
},
99
"main": "index.js",
1010
"files": [
11-
"index.js"
11+
"index.js",
12+
"jest/",
13+
"react/",
14+
"all/",
15+
"rules/"
1216
],
1317
"peerDependencies": {
1418
"babel-eslint": ">=10.0.3 <11",
@@ -44,4 +48,4 @@
4448
"url": "https://github.com/nimjetushar/eslint-rules/issues"
4549
},
4650
"homepage": "https://github.com/nimjetushar/eslint-rules#readme"
47-
}
51+
}

0 commit comments

Comments
 (0)