-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Add new rule for preventing this
in SFCs
#1509
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,136 @@ | ||
# Prevent `this` from being used in stateless functional components (react/no-this-in-sfc) | ||
|
||
When using a stateless functional component (SFC), props/context aren't accessed in the same way as a class component or the `create-react-class` format. Both props and context are passed as separate arguments to the component instead. Also, as the name suggests, a stateless component does not have state on `this.state`. | ||
|
||
Attempting to access properties on `this` can be a potential error if someone is unaware of the differences when writing a SFC or missed when converting a class component to a SFC. | ||
|
||
|
||
## Rule Details | ||
|
||
The following patterns are considered warnings: | ||
|
||
```jsx | ||
function Foo(props) { | ||
return ( | ||
<div>{this.props.bar}</div> | ||
); | ||
} | ||
``` | ||
|
||
```jsx | ||
function Foo(props) { | ||
const { bar } = this.props; | ||
return ( | ||
<div>{bar}</div> | ||
); | ||
} | ||
``` | ||
|
||
```jsx | ||
function Foo(props, context) { | ||
return ( | ||
<div> | ||
{this.context.foo ? this.props.bar : ''} | ||
</div> | ||
); | ||
} | ||
``` | ||
|
||
```jsx | ||
function Foo(props, context) { | ||
const { foo } = this.context; | ||
const { bar } = this.props; | ||
return ( | ||
<div> | ||
{foo ? bar : ''} | ||
</div> | ||
); | ||
} | ||
``` | ||
|
||
```jsx | ||
function Foo(props) { | ||
if (this.state.loading) { | ||
return <Loader />; | ||
} | ||
return ( | ||
<div> | ||
{this.props.bar} | ||
</div> | ||
); | ||
} | ||
``` | ||
|
||
```jsx | ||
function Foo(props) { | ||
const { loading } = this.state; | ||
const { bar } = this.props; | ||
if (loading) { | ||
return <Loader />; | ||
} | ||
return ( | ||
<div> | ||
{bar} | ||
</div> | ||
); | ||
} | ||
``` | ||
|
||
The following patterns are **not** considered warnings: | ||
|
||
```jsx | ||
function Foo(props) { | ||
return ( | ||
<div>{props.bar}</div> | ||
); | ||
} | ||
``` | ||
|
||
```jsx | ||
function Foo(props) { | ||
const { bar } = props; | ||
return ( | ||
<div>{bar}</div> | ||
); | ||
} | ||
``` | ||
|
||
```jsx | ||
function Foo({ bar }) { | ||
return ( | ||
<div>{bar}</div> | ||
); | ||
} | ||
``` | ||
|
||
```jsx | ||
function Foo(props, context) { | ||
return ( | ||
<div> | ||
{context.foo ? props.bar : ''} | ||
</div> | ||
); | ||
} | ||
``` | ||
|
||
```jsx | ||
function Foo(props, context) { | ||
const { foo } = context; | ||
const { bar } = props; | ||
return ( | ||
<div> | ||
{foo ? bar : ''} | ||
</div> | ||
); | ||
} | ||
``` | ||
|
||
```jsx | ||
function Foo({ bar }, { foo }) { | ||
return ( | ||
<div> | ||
{foo ? bar : ''} | ||
</div> | ||
); | ||
} | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
/** | ||
* @fileoverview Report "this" being used in stateless functional components. | ||
*/ | ||
'use strict'; | ||
|
||
const Components = require('../util/Components'); | ||
|
||
// ------------------------------------------------------------------------------ | ||
// Constants | ||
// ------------------------------------------------------------------------------ | ||
|
||
const ERROR_MESSAGE = 'Stateless functional components should not use this'; | ||
|
||
// ------------------------------------------------------------------------------ | ||
// Rule Definition | ||
// ------------------------------------------------------------------------------ | ||
|
||
module.exports = { | ||
meta: { | ||
docs: { | ||
description: 'Report "this" being used in stateless components', | ||
category: 'Possible Errors', | ||
recommended: false | ||
}, | ||
schema: [] | ||
}, | ||
|
||
create: Components.detect((context, components, utils) => ({ | ||
MemberExpression(node) { | ||
const component = components.get(utils.getParentStatelessComponent()); | ||
if (!component) { | ||
return; | ||
} | ||
if (node.object.type === 'ThisExpression') { | ||
context.report({ | ||
node: node, | ||
message: ERROR_MESSAGE | ||
}); | ||
} | ||
} | ||
})) | ||
}; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's also add non-warning patterns (and test cases) for destructured props/context