Skip to content

Commit a3388ae

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

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/rules/finnish.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,22 @@ 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+
## When Not To Use It
72+
73+
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.
74+
However, keep in mind that inconsistent style can harm readability in a project.
75+
76+
Type checked lint rules are more powerful than traditional lint rules, but also require configuring type checked linting.
77+
7178
## Further reading
7279

7380
- [Observables and Finnish Notation](https://medium.com/@benlesh/observables-and-finnish-notation-df8356ed1c9b)
81+
82+
## Related To
83+
84+
- [`no-finnish`](./no-finnish.md)
85+
86+
## Resources
87+
88+
- [Rule source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/src/rules/finnish.ts)
89+
- [Test source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/tests/rules/finnish.test.ts)

0 commit comments

Comments
 (0)