Skip to content

Commit 85db383

Browse files
committed
Update documents for typescript-react-component-type
1 parent 22d77ae commit 85db383

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ See also [Configuring ESLint](https://eslint.org/docs/user-guide/configuring).
4747

4848
| Rule ID | Description | |
4949
|:--------|:------------|:--:|
50-
| [@croutonn/typescript-react-component-type](./docs/rules/typescript-react-component-type.md) | enforce `FC` and `FunctionComponent` types to one or the other | ⭐️ |
50+
| [@croutonn/typescript-react-component-type](./docs/rules/typescript-react-component-type.md) | enforce `FC` and `FunctionComponent` types to one or the other | ⭐️✒️ |
5151
| [@croutonn/typescript-react-require-props-suffix](./docs/rules/typescript-react-require-props-suffix.md) | require that prop interface names be suffixed with `Props` | ⭐️ |
5252
| [@croutonn/typescript-react-require-props-type](./docs/rules/typescript-react-require-props-type.md) | require an props type to be provided to a React component | ⭐️ |
5353

docs/rules/typescript-react-component-type.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# @croutonn/typescript-react-component-type
22
> enforce `FC` and `FunctionComponent` types to one or the other
33
> - ⭐️ This rule is included in `plugin:@croutonn/recommended` preset.
4+
> - ✒️ The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule.
45
56
By enforcing or not suppressing the React component type, a sense of unity is created.
67
You can also enforce `React.FunctionComponent` if "Do not omit" is recommended as a style guide for naming.

0 commit comments

Comments
 (0)