Skip to content

Commit 131cba9

Browse files
committed
docs: update docs for rule folder-match-with-fex
1 parent c156e3d commit 131cba9

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

docs/rules/folder-match-with-fex.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# The folder should match the naming pattern specified by the file extension (folder-match-with-fex)
1+
# The folder should match the naming pattern specified by its file (folder-match-with-fex)
22

3-
Allows you to enforce a consistent naming pattern for the folder of the specified file.
3+
Allows you to enforce a consistent naming pattern for the specified files' folder names.
44

55
## Rule Details
66

7-
This rule aims to format the folder of the specified file. This rule uses the glob match syntax to match a file and declare the naming pattern for the folder.
7+
This rule aims to format the folder of the specified files. It will be useful when you want to group the specified files into a folder. This rule uses the glob match syntax to match target files and declare the naming pattern for their folder names.
88

99
If the rule had been set as follows:
1010
```js
@@ -27,8 +27,7 @@ bar/__tests__/foo.test.js
2727

2828
#### naming pattern object
2929

30-
You need to specify a different naming pattern for different file extensions. The plugin will only check files with extensions you explicitly provided:
31-
30+
The key is used to select target files, while the value is used to declare the naming pattern for their folder names. You can specify a different folder naming pattern for different target files. The plugin will only check files you explicitly provided:
3231
```js
3332
module.exports = {
3433
plugins: [

0 commit comments

Comments
 (0)