Skip to content

Commit 906e373

Browse files
committed
docs: update docs for rule filename-blocklist
1 parent 73ad195 commit 906e373

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/rules/filename-blocklist.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Allows you to blocklist certain file name patterns.
44

5+
:warning: :warning: :warning:
6+
7+
**The rule was called `filename-blacklist` in versions below v2.0.0. This rule name has been abandoned since it is less inclusive. Please update to the latest rule name.**
8+
59
## Rule Details
610

711
This rule aims to maintain a consistent naming scheme.
@@ -30,7 +34,7 @@ src/bar.models.ts
3034

3135
#### blocklist pattern object
3236

33-
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.
37+
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:
3438

3539
```js
3640
module.exports = {

0 commit comments

Comments
 (0)