Skip to content

Commit b8f53b7

Browse files
committed
docs: update docs for rule filename-blocklist
1 parent a8a3148 commit b8f53b7

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/rules/filename-blocklist.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Allows you to blocklist certain file name patterns.
88

99
## Rule Details
1010

11-
This rule aims to maintain a consistent naming scheme.
11+
This rule aims to maintain a consistent naming scheme. This rule uses the glob match syntax to declare blocklisted and preferred filename patterns.
1212

1313
If the rule had been set as follows:
1414
```js
@@ -31,14 +31,14 @@ src/bar.models.ts
3131

3232
:warning: :warning: :warning:
3333

34-
**Versions <= v2.0.0 can only select target files by their filenames, not by their paths. This support has been deprecated and will be removed in the future. Please select your target files by their file path. For example, using `**/*.js` instead of `*.js` to select all `js` files.**
34+
**Versions <= v2.0.0 can only select target files by their filenames, not by their paths. This support has been deprecated and will be removed in the future. Please select your target files by their file path. For example, using `**/*.js` instead of `*.js` to select all `js` files.**
3535

3636

3737
### Options
3838

3939
#### blocklist pattern object
4040

41-
You need to specify a different naming pattern for each filename blocklist. The second pattern is used to hint at the correct file name that should be used instead. The plugin will only check blocklisted pattern you explicitly provided:
41+
The key is used to declare the blocklisted filename pattern, while the value is used to hint at the correct filename that should be used instead. Both the key and value in the blocklist pattern object are glob expressions. The plugin will only check blocklisted pattern you explicitly provided:
4242

4343
```js
4444
module.exports = {

0 commit comments

Comments
 (0)