Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Allow this.state assignment on constructor #1223

Merged
merged 1 commit into from
Jun 21, 2017
Merged

Allow this.state assignment on constructor #1223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/rules/no-direct-mutation-state.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
NEVER mutate `this.state` directly, as calling `setState()` afterwards may replace
the mutation you made. Treat `this.state` as if it were immutable.

The only place that's acceptable to assign this.state is in a ES6 `class` component constructor.

## Rule Details

This rule is aimed to forbid the use of mutating `this.state` directly.
Expand All @@ -18,6 +20,17 @@ var Hello = createReactClass({
return <div>Hello {this.state.name}</div>;
}
});

class Hello extends React.Component {
constructor(props) {
super(props)

// Assign at instance creation time, not on a callback
doSomethingAsync(() => {
this.state = 'bad';
});
}
}
```


Expand All @@ -34,4 +47,14 @@ var Hello = createReactClass({
return <div>Hello {this.state.name}</div>;
}
});

class Hello extends React.Component {
constructor(props) {
super(props)

this.state = {
foo: 'bar',
}
}
}
```
55 changes: 38 additions & 17 deletions lib/rules/no-direct-mutation-state.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @fileoverview Prevent direct mutation of this.state
* @author David Petersen
* @author Nicolas Fernandez <@burabure>
*/
'use strict';

var has = require('has');
var Components = require('../util/Components');

// ------------------------------------------------------------------------------
Expand Down Expand Up @@ -49,41 +49,62 @@ module.exports = {
// --------------------------------------------------------------------------
// Public
// --------------------------------------------------------------------------
let inConstructor = false;
let inCallExpression = false;

return {
AssignmentExpression: function(node) {
var item;
if (!node.left || !node.left.object || !node.left.object.object) {
MethodDefinition(node) {
if (node.kind === 'constructor') {
inConstructor = true;
}
},

CallExpression: function() {
inCallExpression = true;
},

AssignmentExpression(node) {
let item;
if ((inConstructor && !inCallExpression) || !node.left || !node.left.object) {
return;
}
item = node.left.object;
while (item.object.property) {
item = node.left;
while (item.object && item.object.property) {
item = item.object;
}
if (
item.object.type === 'ThisExpression' &&
item.property.name === 'state'
) {
var component = components.get(utils.getParentComponent());
var mutations = component && component.mutations || [];
const component = components.get(utils.getParentComponent());
const mutations = (component && component.mutations) || [];
mutations.push(node.left.object);
components.set(node, {
mutateSetState: true,
mutations: mutations
mutations
});
}
},

'Program:exit': function() {
var list = components.list();
for (var component in list) {
if (!has(list, component) || isValid(list[component])) {
continue;
}
reportMutations(list[component]);
'CallExpression:exit': function() {
inCallExpression = false;
},

'MethodDefinition:exit': function (node) {
if (node.kind === 'constructor') {
inConstructor = false;
}
},

'Program:exit': function () {
const list = components.list();

Object.keys(list).forEach((key) => {
if (!isValid(list[key])) {
reportMutations(list[key]);
}
});
}
};

})
};
113 changes: 113 additions & 0 deletions tests/lib/rules/no-direct-mutation-state.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,14 @@ ruleTester.run('no-direct-mutation-state', rule, {
' }',
'}'
].join('\n')
}, {
code: [
'class Hello extends React.Component {',
' constructor() {',
' this.state.foo = "bar"',
' }',
'}'
].join('\n')
}],

invalid: [{
Expand Down Expand Up @@ -118,6 +126,111 @@ ruleTester.run('no-direct-mutation-state', rule, {
line: 4,
column: 5
}]
}, {
code: [
'class Hello extends React.Component {',
' constructor() {',
' someFn()',
' }',
' someFn() {',
' this.state.foo = "bar"',
' }',
'}'
].join('\n'),
errors: [{
message: 'Do not mutate state directly. Use setState().'
}]
}, {
code: [
'class Hello extends React.Component {',
' constructor(props) {',
' super(props)',
' doSomethingAsync(() => {',
' this.state = "bad";',
' });',
' }',
'}'
].join('\n'),
errors: [{
message: 'Do not mutate state directly. Use setState().'
}]
}, {
code: [
'class Hello extends React.Component {',
' componentWillMount() {',
' this.state.foo = "bar"',
' }',
'}'
].join('\n'),
errors: [{
message: 'Do not mutate state directly. Use setState().'
}]
}, {
code: [
'class Hello extends React.Component {',
' componentDidMount() {',
' this.state.foo = "bar"',
' }',
'}'
].join('\n'),
errors: [{
message: 'Do not mutate state directly. Use setState().'
}]
}, {
code: [
'class Hello extends React.Component {',
' componentWillReceiveProps() {',
' this.state.foo = "bar"',
' }',
'}'
].join('\n'),
errors: [{
message: 'Do not mutate state directly. Use setState().'
}]
}, {
code: [
'class Hello extends React.Component {',
' shouldComponentUpdate() {',
' this.state.foo = "bar"',
' }',
'}'
].join('\n'),
errors: [{
message: 'Do not mutate state directly. Use setState().'
}]
}, {
code: [
'class Hello extends React.Component {',
' componentWillUpdate() {',
' this.state.foo = "bar"',
' }',
'}'
].join('\n'),
errors: [{
message: 'Do not mutate state directly. Use setState().'
}]
}, {
code: [
'class Hello extends React.Component {',
' componentDidUpdate() {',
' this.state.foo = "bar"',
' }',
'}'
].join('\n'),
errors: [{
message: 'Do not mutate state directly. Use setState().'
}]
}, {
code: [
'class Hello extends React.Component {',
' componentWillUnmount() {',
' this.state.foo = "bar"',
' }',
'}'
].join('\n'),
errors: [{
message: 'Do not mutate state directly. Use setState().'
}]
}
/**
* Would be nice to prevent this too
Expand Down