Skip to content

Commit c22dcfe

Browse files
docs: update readme for recommended standard rules
1 parent 59cf6b1 commit c22dcfe

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -263,17 +263,20 @@ Without this rule, function parameters are mutable.
263263
264264
This rule is helpful when converting from an imperative code style to a functional one.
265265
266-
### [@typescript-eslint/explicit-function-return-type](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/explicit-function-return-type.md)
266+
### [@typescript-eslint/prefer-readonly](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-readonly.md)
267267
268-
For performance reasons, eslint-plugin-functional does not check implicit return types. So for example this function will return a mutable array but will not be detected:
268+
This rule is helpful when working with classes.
269269
270-
```js
271-
function foo() {
272-
return [1, 2, 3];
273-
}
274-
```
270+
### [@typescript-eslint/prefer-readonly-parameter-types](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-readonly-parameter-types.md)
271+
272+
Functional functions must not modify any data passed into them.
273+
This rule marks mutable parameters as a violation as they prevent readonly versions of that data from being passed in.
274+
275+
However, due to many 3rd-party libraries only providing mutable versions of their types, often it can not be easy to satisfy this rule. Thus by default we only enable this rule with the "warn" serverity rather than "error".
276+
277+
### [@typescript-eslint/switch-exhaustiveness-check](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/switch-exhaustiveness-check.md)
275278
276-
To avoid this situation you can enable `@typescript-eslint/explicit-function-return-type`. Now the above function is forced to declare the return type and the mutability will be detected.
279+
Although our [no-conditional-statement](./docs/rules/no-conditional-statement.md) rule also performs this check, this rule has a fixer that will implement the unimplemented cases which can be useful.
277280
278281
## How to contribute
279282

0 commit comments

Comments
 (0)