Skip to content

Commit 8e6e099

Browse files
committed
docs: update readme
1 parent eadb44a commit 8e6e099

File tree

1 file changed

+34
-27
lines changed

1 file changed

+34
-27
lines changed

README.md

Lines changed: 34 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ Add `check-file` to the plugins section of your `.eslintrc` configuration file.
2323

2424
```json
2525
{
26-
"plugins": [
27-
"check-file"
28-
]
26+
"plugins": [
27+
"check-file"
28+
]
2929
}
3030
```
3131

@@ -34,30 +34,37 @@ Then configure the rules you want to use under the rules section.
3434

3535
```json
3636
{
37-
"rules":{
38-
"check-file/folder-match-with-fex":[
39-
"error",
40-
{
41-
"*.test.{js,jsx,ts,tsx}":"**/__tests__/",
42-
"*.styled.{jsx,tsx}":"**/pages/"
43-
}
44-
],
45-
"check-file/filename-naming-convention":[
46-
"error",
47-
{
48-
"**/*.{jsx,tsx}":"CAMEL_CASE",
49-
"**/*.{js,ts}":"KEBAB_CASE"
50-
}
51-
],
52-
"check-file/no-index":"error",
53-
"check-file/folder-naming-convention":[
54-
"error",
55-
{
56-
"src/**/":"CAMEL_CASE",
57-
"mocks/*/":"KEBAB_CASE"
58-
}
59-
]
60-
}
37+
"rules": {
38+
"check-file/folder-match-with-fex": [
39+
"error",
40+
{
41+
"*.test.{js,jsx,ts,tsx}": "**/__tests__/",
42+
"*.styled.{jsx,tsx}": "**/pages/"
43+
}
44+
],
45+
"check-file/filename-naming-convention": [
46+
"error",
47+
{
48+
"**/*.{jsx,tsx}": "CAMEL_CASE",
49+
"**/*.{js,ts}": "KEBAB_CASE"
50+
}
51+
],
52+
"check-file/no-index": "error",
53+
"check-file/folder-naming-convention": [
54+
"error",
55+
{
56+
"src/**/": "CAMEL_CASE",
57+
"mocks/*/": "KEBAB_CASE"
58+
}
59+
],
60+
"check-file/filename-blacklist": [
61+
"error",
62+
{
63+
"**/*.model.ts": "*.models.ts",
64+
"**/*.util.ts": "*.utils.ts"
65+
}
66+
]
67+
}
6168
}
6269
```
6370

0 commit comments

Comments
 (0)