Skip to content

Commit feaa2ed

Browse files
docs(no-finnish): when not to use it
1 parent a3388ae commit feaa2ed

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/rules/no-finnish.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,22 @@ Examples of **correct** code for this rule:
2020
const answers = of(42, 54);
2121
```
2222

23+
## When Not To Use It
24+
25+
If you use Finnish notation in your project or don't care if Finnish notation is used in your project, you don't need this rule.
26+
However, keep in mind that inconsistent style can harm readability in a project.
27+
28+
Type checked lint rules are more powerful than traditional lint rules, but also require configuring type checked linting.
29+
2330
## Further reading
2431

2532
- [Observables and Finnish Notation](https://medium.com/@benlesh/observables-and-finnish-notation-df8356ed1c9b)
33+
34+
## Related To
35+
36+
- [`finnish`](./finnish.md)
37+
38+
## Resources
39+
40+
- [Rule source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/src/rules/no-finnish.ts)
41+
- [Test source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/tests/rules/no-finnish.test.ts)

0 commit comments

Comments
 (0)