Skip to content

For deprecated lifecycle methods, report identifier AST node instead of the class node #1854

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

Merged
merged 3 commits into from
Jun 28, 2018
Merged

For deprecated lifecycle methods, report identifier AST node instead of the class node #1854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c4cef42
For deprecated lifecycle methods, report identifier node instead of t…
jsnajdr Jun 26, 2018
a5ded4d
Add line/column checks in tests for deprecated lifecycle methods
jsnajdr Jun 26, 2018
248c2ca
Remove endLine/Column tests: not supported in ESLint 3
jsnajdr Jun 26, 2018
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
21 changes: 12 additions & 9 deletions lib/rules/no-deprecated.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,19 +106,19 @@ module.exports = {
);
}

function checkDeprecation(node, method) {
if (!isDeprecated(method)) {
function checkDeprecation(node, methodName, methodNode) {
if (!isDeprecated(methodName)) {
return;
}
const deprecated = getDeprecated();
const version = deprecated[method][0];
const newMethod = deprecated[method][1];
const refs = deprecated[method][2];
const version = deprecated[methodName][0];
const newMethod = deprecated[methodName][1];
const refs = deprecated[methodName][2];
context.report({
node: node,
node: methodNode || node,
message: DEPRECATED_MESSAGE,
data: {
oldMethod: method,
oldMethod: methodName,
version,
newMethod: newMethod ? `, use ${newMethod} instead` : '',
refs: refs ? `, see ${refs}` : ''
Expand Down Expand Up @@ -150,7 +150,10 @@ module.exports = {
*/
function getLifeCycleMethods(node) {
const properties = astUtil.getComponentProperties(node);
return properties.map(property => astUtil.getPropertyName(property));
return properties.map(property => ({
name: astUtil.getPropertyName(property),
node: astUtil.getPropertyNameNode(property)
}));
}

/**
Expand All @@ -160,7 +163,7 @@ module.exports = {
function checkLifeCycleMethods(node) {
if (utils.isES5Component(node) || utils.isES6Component(node)) {
const methods = getLifeCycleMethods(node);
methods.forEach(method => checkDeprecation(node, method));
methods.forEach(method => checkDeprecation(node, method.name, method.node));
}
}

Expand Down
23 changes: 17 additions & 6 deletions lib/util/ast.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,27 @@ function findReturnStatement(node) {
}

/**
* Get properties name
* Get node with property's name
* @param {Object} node - Property.
* @returns {String} Property name.
* @returns {Object} Property name node.
*/
function getPropertyName(node) {
function getPropertyNameNode(node) {
if (node.key || ['MethodDefinition', 'Property'].indexOf(node.type) !== -1) {
return node.key.name;
return node.key;
} else if (node.type === 'MemberExpression') {
return node.property.name;
return node.property;
}
return '';
return null;
}

/**
* Get properties name
* @param {Object} node - Property.
* @returns {String} Property name.
*/
function getPropertyName(node) {
const nameNode = getPropertyNameNode(node);
return nameNode ? nameNode.name : '';
}

/**
Expand Down Expand Up @@ -88,6 +98,7 @@ function isNodeFirstInLine(context, node) {
module.exports = {
findReturnStatement: findReturnStatement,
getPropertyName: getPropertyName,
getPropertyNameNode: getPropertyNameNode,
getComponentProperties: getComponentProperties,
isNodeFirstInLine: isNodeFirstInLine
};
105 changes: 84 additions & 21 deletions tests/lib/rules/no-deprecated.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,18 +223,27 @@ ruleTester.run('no-deprecated', rule, {
message: errorMessage(
'componentWillMount', '16.3.0', 'UNSAFE_componentWillMount',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillmount'
)
),
type: 'Identifier',
line: 3,
column: 11
},
{
message: errorMessage(
'componentWillReceiveProps', '16.3.0', 'UNSAFE_componentWillReceiveProps',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillreceiveprops'
)
),
type: 'Identifier',
line: 4,
column: 11
},
{
message: errorMessage('componentWillUpdate', '16.3.0', 'UNSAFE_componentWillUpdate',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillupdate'
)
),
type: 'Identifier',
line: 5,
column: 11
}
]
},
Expand All @@ -253,18 +262,27 @@ ruleTester.run('no-deprecated', rule, {
message: errorMessage(
'componentWillMount', '16.3.0', 'UNSAFE_componentWillMount',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillmount'
)
),
type: 'Identifier',
line: 4,
column: 13
},
{
message: errorMessage(
'componentWillReceiveProps', '16.3.0', 'UNSAFE_componentWillReceiveProps',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillreceiveprops'
)
),
type: 'Identifier',
line: 5,
column: 13
},
{
message: errorMessage('componentWillUpdate', '16.3.0', 'UNSAFE_componentWillUpdate',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillupdate'
)
),
type: 'Identifier',
line: 6,
column: 13
}
]
},
Expand All @@ -281,18 +299,27 @@ ruleTester.run('no-deprecated', rule, {
message: errorMessage(
'componentWillMount', '16.3.0', 'UNSAFE_componentWillMount',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillmount'
)
),
type: 'Identifier',
line: 3,
column: 11
},
{
message: errorMessage(
'componentWillReceiveProps', '16.3.0', 'UNSAFE_componentWillReceiveProps',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillreceiveprops'
)
),
type: 'Identifier',
line: 4,
column: 11
},
{
message: errorMessage('componentWillUpdate', '16.3.0', 'UNSAFE_componentWillUpdate',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillupdate'
)
),
type: 'Identifier',
line: 5,
column: 11
}
]
},
Expand All @@ -309,18 +336,27 @@ ruleTester.run('no-deprecated', rule, {
message: errorMessage(
'componentWillMount', '16.3.0', 'UNSAFE_componentWillMount',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillmount'
)
),
type: 'Identifier',
line: 3,
column: 11
},
{
message: errorMessage(
'componentWillReceiveProps', '16.3.0', 'UNSAFE_componentWillReceiveProps',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillreceiveprops'
)
),
type: 'Identifier',
line: 4,
column: 11
},
{
message: errorMessage('componentWillUpdate', '16.3.0', 'UNSAFE_componentWillUpdate',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillupdate'
)
),
type: 'Identifier',
line: 5,
column: 11
}
]
},
Expand All @@ -337,18 +373,27 @@ ruleTester.run('no-deprecated', rule, {
message: errorMessage(
'componentWillMount', '16.3.0', 'UNSAFE_componentWillMount',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillmount'
)
),
type: 'Identifier',
line: 3,
column: 11
},
{
message: errorMessage(
'componentWillReceiveProps', '16.3.0', 'UNSAFE_componentWillReceiveProps',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillreceiveprops'
)
),
type: 'Identifier',
line: 4,
column: 11
},
{
message: errorMessage('componentWillUpdate', '16.3.0', 'UNSAFE_componentWillUpdate',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillupdate'
)
),
type: 'Identifier',
line: 5,
column: 11
}
]
},
Expand All @@ -365,18 +410,27 @@ ruleTester.run('no-deprecated', rule, {
message: errorMessage(
'componentWillMount', '16.3.0', 'UNSAFE_componentWillMount',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillmount'
)
),
type: 'Identifier',
line: 3,
column: 11
},
{
message: errorMessage(
'componentWillReceiveProps', '16.3.0', 'UNSAFE_componentWillReceiveProps',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillreceiveprops'
)
),
type: 'Identifier',
line: 4,
column: 11
},
{
message: errorMessage('componentWillUpdate', '16.3.0', 'UNSAFE_componentWillUpdate',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillupdate'
)
),
type: 'Identifier',
line: 5,
column: 11
}
]
},
Expand All @@ -394,18 +448,27 @@ ruleTester.run('no-deprecated', rule, {
message: errorMessage(
'componentWillMount', '16.3.0', 'UNSAFE_componentWillMount',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillmount'
)
),
type: 'Identifier',
line: 4,
column: 11
},
{
message: errorMessage(
'componentWillReceiveProps', '16.3.0', 'UNSAFE_componentWillReceiveProps',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillreceiveprops'
)
),
type: 'Identifier',
line: 5,
column: 11
},
{
message: errorMessage('componentWillUpdate', '16.3.0', 'UNSAFE_componentWillUpdate',
'https://reactjs.org/docs/react-component.html#unsafe_componentwillupdate'
)
),
type: 'Identifier',
line: 6,
column: 11
}
]
}
Expand Down