Skip to content

Commit 05a288e

Browse files
committed
docs(#23): update docs for rule folder-naming-convention
1 parent 489f339 commit 05a288e

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/rules/folder-naming-convention.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Allows you to enforce a consistent naming pattern for the name of the specified
66

77
This rule aims to format the name of the specified folder. This rule uses the glob match syntax to match target folders and declare the naming pattern for the folder name.
88

9-
There are six naming conventions built into this rule, including `CAMEL_CASE`, `PASCAL_CASE`, `SNAKE_CASE`, `KEBAB_CASE`, `SCREAMING_SNAKE_CASE` and `FLAT_CASE`.
9+
There are six basic naming conventions built into this rule, including `CAMEL_CASE`, `PASCAL_CASE`, `SNAKE_CASE`, `KEBAB_CASE`, `SCREAMING_SNAKE_CASE` and `FLAT_CASE`.
1010

1111
| Formatting | Name |
1212
|---|---|
@@ -17,6 +17,8 @@ There are six naming conventions built into this rule, including `CAMEL_CASE`, `
1717
| HELLO_WORLD | `SCREAMING_SNAKE_CASE` |
1818
| helloworld | `FLAT_CASE` |
1919

20+
And there are a naming convention `NEXT_JS_APP_ROUTER_CASE` for the Next.js app router, which is used to format its folder name.
21+
2022
If the rule had been set as follows:
2123
```js
2224
...

0 commit comments

Comments
 (0)