Skip to content

Commit c156e3d

Browse files
committed
docs: update docs for rule folder-naming-convention
1 parent b8f53b7 commit c156e3d

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/rules/folder-naming-convention.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Allows you to enforce a consistent naming pattern for the name of the specified
44

55
## Rule Details
66

7-
This rule aims to format the name of the specified folder. This rule uses the glob match syntax to match a folder and declare the naming pattern for the name.
7+
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

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

@@ -51,7 +51,7 @@ In addition to the built-in naming conventions, you can also set custom naming p
5151

5252
#### naming pattern object
5353

54-
You need to specify a different naming pattern for different folder. The plugin will only check folders you explicitly provided:
54+
The key is used to select target folders, while the value is used to declare the naming pattern for the folder name. You can specify a different naming pattern for different target folders. The plugin will only check folders you explicitly provided:
5555

5656
```js
5757
module.exports = {

0 commit comments

Comments
 (0)