Skip to content

Commit 893e240

Browse files
committed
docs: update README
1 parent cbb6d99 commit 893e240

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,14 @@ Then configure the rules you want to use under the rules section.
3838
```json
3939
{
4040
"rules": {
41+
"check-file/no-index": "error",
42+
"check-file/filename-blocklist": [
43+
"error",
44+
{
45+
"**/*.model.ts": "*.models.ts",
46+
"**/*.util.ts": "*.utils.ts"
47+
}
48+
],
4149
"check-file/folder-match-with-fex": [
4250
"error",
4351
{
@@ -52,32 +60,24 @@ Then configure the rules you want to use under the rules section.
5260
"**/*.{js,ts}": "KEBAB_CASE"
5361
}
5462
],
55-
"check-file/no-index": "error",
5663
"check-file/folder-naming-convention": [
5764
"error",
5865
{
5966
"src/**/": "CAMEL_CASE",
6067
"mocks/*/": "KEBAB_CASE"
6168
}
62-
],
63-
"check-file/filename-blocklist": [
64-
"error",
65-
{
66-
"**/*.model.ts": "*.models.ts",
67-
"**/*.util.ts": "*.utils.ts"
68-
}
6969
]
7070
}
7171
}
7272
```
7373

7474
## Supported Rules
7575

76+
- [check-file/no-index](docs/rules/no-index.md): A file cannot be named "index"
77+
- [check-file/filename-blocklist](docs/rules/filename-blocklist.md): Blocklist file names by pattern
7678
- [check-file/folder-match-with-fex](docs/rules/folder-match-with-fex.md): Enforce a consistent naming pattern for folder names for specified files
7779
- [check-file/filename-naming-convention](docs/rules/filename-naming-convention.md): Enforce a consistent naming pattern for filenames for specified files
78-
- [check-file/no-index](docs/rules/no-index.md): A file cannot be named "index"
7980
- [check-file/folder-naming-convention](docs/rules/folder-naming-convention.md): Enforce a consistent naming pattern for folder names for specified folders
80-
- [check-file/filename-blocklist](docs/rules/filename-blocklist.md): Blocklist file names by pattern
8181

8282
[![Donate][ko-fi-image]][ko-fi-url]
8383

0 commit comments

Comments
 (0)