Skip to content

Commit b492c40

Browse files
docs(suffix-subjects): document expected behavior about Finnish compatibility
See #109
1 parent 7b138ef commit b492c40

File tree

2 files changed

+5
-16
lines changed

2 files changed

+5
-16
lines changed

docs/rules/finnish.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -68,19 +68,6 @@ The default (Angular-friendly) configuration looks like this:
6868

6969
The properties in the options object are themselves optional; they do not all have to be specified.
7070

71-
Note the default options of this rule will conflict with [`suffix-subjects`](./suffix-subjects.md).
72-
If you want to handle subjects separately with `suffix-subjects` (or another rule),
73-
then add the following to your `finnish` options:
74-
75-
```js
76-
"types": {
77-
// The default allowed types.
78-
"^EventEmitter$": false,
79-
// The subject types to be compatible with suffix-subjects.
80-
"^(BehaviorSubject|ReplaySubject|AsyncSubject|Subject)$": false,
81-
}
82-
```
83-
8471
## When Not To Use It
8572

8673
If you don't use Finnish notation in your project or don't care about enforcing Finnish notation in your project, you don't need this rule.

docs/rules/suffix-subjects.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66

77
This rule effects failures if subject variables, properties and parameters don't conform to a naming scheme that identifies them as subjects.
88

9+
> [!NOTE]
10+
> This rule is designed to be optionally compatible with [`finnish`](./finnish.md).
11+
> Using Finnish notation (adding a `$` suffix) your subject names will _not_ cause a failure of this rule.
12+
913
## Rule details
1014

1115
Examples of **incorrect** code for this rule:
@@ -18,6 +22,7 @@ Examples of **correct** code for this rule:
1822

1923
```ts
2024
const answersSubject = new Subject<number>();
25+
const answersSubject$ = new Subject<number>();
2126
```
2227

2328
## Options
@@ -57,9 +62,6 @@ The default (Angular-friendly) configuration looks like this:
5762

5863
The properties in the options object are themselves optional; they do not all have to be specified.
5964

60-
Note this rule will conflict with [`finnish`](./finnish.md) with default options.
61-
See that rule for notes on how to configure both rules.
62-
6365
## When Not To Use It
6466

6567
If you don't use suffixes on your project's subjects, then you don't need this rule.

0 commit comments

Comments
 (0)