You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/rules/folder-naming-convention.md
+22-17
Original file line number
Diff line number
Diff line change
@@ -8,18 +8,21 @@ This rule aims to format the name of the specified folder. This rule uses the gl
8
8
9
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`.
10
10
11
-
| Formatting | Name |
12
-
|---|---|
13
-
| helloWorld |`CAMEL_CASE`|
14
-
| HelloWorld |`PASCAL_CASE`|
15
-
| hello_world |`SNAKE_CASE`|
16
-
| hello-world |`KEBAB_CASE`|
17
-
| HELLO_WORLD |`SCREAMING_SNAKE_CASE`|
18
-
| helloworld |`FLAT_CASE`|
11
+
**Additionally, there is a naming convention called `NEXT_JS_APP_ROUTER_CASE` used to format folder names in Next.js projects that used App Router.**`NEXT_JS_APP_ROUTER_CASE` aims to support a wide range of named constructs in Next.js App Router projects, including Standard routes, Dynamic segments, Catch-all segments, Optional Catch-all Segments, Route groups, and Named slots.
12
+
13
+
While `NEXT_JS_APP_ROUTER_CASE` covers many naming cases, it's possible that some cases may be missing. If you come across any missing cases, I encourage you to open an issue and provide the necessary details. Your feedback will help me improve and enhance the naming convention.
19
14
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.
In addition to the built-in naming conventions, you can also set custom naming patterns using glob match syntax. The following code shows an example of how to ensure that all the folders under the `components` folder are named begin with `__`:
0 commit comments