From b7a9c2ab996192a3a398c1bb586c225c86835f49 Mon Sep 17 00:00:00 2001 From: Nix Date: Sat, 30 Apr 2022 07:27:09 +0900 Subject: [PATCH] [Docs] `default-props-match-prop-types`, `require-default-props`, `sort-prop-types`: fix typos --- CHANGELOG.md | 2 ++ docs/rules/default-props-match-prop-types.md | 3 ++- docs/rules/require-default-props.md | 4 ++-- docs/rules/sort-prop-types.md | 5 +++++ 4 files changed, 11 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d12e36fcf1..ec642085c4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -29,7 +29,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange * [Refactor] [`no-did-mount-set-state`], [`no-did-update-set-state`], [`no-will-update-set-state`]: improve performance ([#3272][] @golopot) * [Refactor] improve performance by avoiding unnecessary `Components.detect` ([#3273][] @golopot) * [Refactor] add `isParenthesized` AST util ([#3203][] @Belco90) +* [Docs] `default-props-match-prop-types`, `require-default-props`, `sort-prop-types`: fix typos ([#3279][] @nix6839) +[#3279]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3279 [#3273]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3273 [#3272]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3272 [#3271]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3271 diff --git a/docs/rules/default-props-match-prop-types.md b/docs/rules/default-props-match-prop-types.md index 4e0b25bd6f..c3b8bd6400 100644 --- a/docs/rules/default-props-match-prop-types.md +++ b/docs/rules/default-props-match-prop-types.md @@ -127,7 +127,7 @@ MyStatelessComponent.propTypes = { }; MyStatelessComponent.defaultProps = { - bar: 'some default' + bar: 'some default' }; ``` @@ -193,6 +193,7 @@ If you don't care about stray `defaultsProps` in your components, you can disabl - [require-default-props](./require-default-props.md) # Resources + - [Official React documentation on defaultProps](https://facebook.github.io/react/docs/typechecking-with-proptypes.html#default-prop-values) [PropTypes]: https://reactjs.org/docs/typechecking-with-proptypes.html diff --git a/docs/rules/require-default-props.md b/docs/rules/require-default-props.md index bacb416454..1ccf7294e9 100644 --- a/docs/rules/require-default-props.md +++ b/docs/rules/require-default-props.md @@ -165,7 +165,7 @@ MyStatelessComponent.propTypes = { }; MyStatelessComponent.defaultProps = { - bar: 'some default' + bar: 'some default' }; ``` @@ -199,7 +199,7 @@ NotAComponent.propTypes = { ... "react/require-default-props": [, { "forbidDefaultForRequired": , - "classes": "defaultProps | "ignore", + "classes": "defaultProps" | "ignore", "functions": "defaultProps" | "defaultArguments" | "ignore" // @deprecated Use `functions` option instead. "ignoreFunctionalComponents": , diff --git a/docs/rules/sort-prop-types.md b/docs/rules/sort-prop-types.md index e8b09f66f7..5b05645ec1 100644 --- a/docs/rules/sort-prop-types.md +++ b/docs/rules/sort-prop-types.md @@ -18,6 +18,7 @@ var Component = createReactClass({ ... }); ``` + ```jsx type Props = { z: number, @@ -28,6 +29,7 @@ class Component extends React.Component { ... } ``` + ```jsx class Component extends React.Component { static propTypes = { @@ -53,6 +55,7 @@ var Component = createReactClass({ ... }); ``` + ```jsx type Props = { a: string, @@ -63,6 +66,7 @@ class Component extends React.Component { ... } ``` + ```jsx class Component extends React.Component { static propTypes = { @@ -144,6 +148,7 @@ var Component = createReactClass({ ... }); ``` + ### `noSortAlphabetically` When `true`, alphabetical order is not enforced: