From 2525383cd82e995f1f0de172601c853f16b27b8d Mon Sep 17 00:00:00 2001 From: Joachim Seminck Date: Sun, 17 Sep 2017 13:19:13 +0300 Subject: [PATCH] Add docs for no-unused-state --- README.md | 1 + docs/rules/no-unused-state.md | 45 +++++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+) create mode 100644 docs/rules/no-unused-state.md diff --git a/README.md b/README.md index 35312840e3..413ed101d1 100644 --- a/README.md +++ b/README.md @@ -108,6 +108,7 @@ Finally, enable all of the rules that you would like to use. Use [our preset](# * [react/no-unescaped-entities](docs/rules/no-unescaped-entities.md): Prevent invalid characters from appearing in markup * [react/no-unknown-property](docs/rules/no-unknown-property.md): Prevent usage of unknown DOM property (fixable) * [react/no-unused-prop-types](docs/rules/no-unused-prop-types.md): Prevent definitions of unused prop types +* [react/no-unused-state](docs/rules/no-unused-state.md): Prevent definitions of unused state properties * [react/no-will-update-set-state](docs/rules/no-will-update-set-state.md): Prevent usage of `setState` in `componentWillUpdate` * [react/prefer-es6-class](docs/rules/prefer-es6-class.md): Enforce ES5 or ES6 class for React Components * [react/prefer-stateless-function](docs/rules/prefer-stateless-function.md): Enforce stateless React Components to be written as a pure function diff --git a/docs/rules/no-unused-state.md b/docs/rules/no-unused-state.md new file mode 100644 index 0000000000..6d859d78db --- /dev/null +++ b/docs/rules/no-unused-state.md @@ -0,0 +1,45 @@ +# Prevent definitions of unused state (react/no-unused-state) + +Warns you if you have defined a property on the state, but it is not being used anywhere. + +## Rule Details + +The following patterns are considered warnings: + +```jsx +class MyComponent extends React.Component { + state = { foo: 0 }; + render() { + return ; + } +} + +var UnusedGetInitialStateTest = createReactClass({ + getInitialState: function() { + return { foo: 0 }; + }, + render: function() { + return ; + } +}) +``` + +The following patterns are not considered warnings: + +```jsx +class MyComponent extends React.Component { + state = { foo: 0 }; + render() { + return ; + } +} + +var UnusedGetInitialStateTest = createReactClass({ + getInitialState: function() { + return { foo: 0 }; + }, + render: function() { + return ; + } +}) +``` \ No newline at end of file