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

prefer-node-remove: Only fix when expression is not used #498

Merged
merged 9 commits into from Jan 21, 2020
Merged

prefer-node-remove: Only fix when expression is not used #498

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
65e9f46
Minor optimizations in `prefer-node-append`
brettz9 Jan 17, 2020
57c0acd
Update package-lock.json (bumped upon running per integration tests)
brettz9 Jan 17, 2020
b009984
Fix: Do not apply fixer in `prefer-node-remove` if in a context to se…
brettz9 Jan 17, 2020
b1e13f0
update per refactoring of @fisker (and apply to `prefer-node-append` …
brettz9 Jan 19, 2020
be2e063
Implement a `isReturnValueUsed` utility
brettz9 Jan 20, 2020
c0ea0b0
Rename utility to `isValueUsed`
brettz9 Jan 20, 2020
3d36ff6
- Invert behavior so naming is accurate
brettz9 Jan 20, 2020
2fb2d22
Simplifying per @fisker's suggestions
brettz9 Jan 20, 2020
2e6eefe
In prefer-node-* methods, avoid fixer when parent is `AssignmentExpre…
brettz9 Jan 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 3 additions & 26 deletions rules/prefer-node-append.js
View file
Open in desktop
@@ -1,41 +1,18 @@
'use strict';
const getDocumentationUrl = require('./utils/get-documentation-url');
const isReturnValueUsed = require('./utils/is-return-value-used');

const getMethodName = memberExpression => memberExpression.property.name;

const ignoredParentTypes = [
'ArrayExpression',
'IfStatement',
'MemberExpression',
'Property',
'ReturnStatement',
'VariableDeclarator'
];

const ignoredGrandparentTypes = [
'ExpressionStatement'
];

const create = context => {
return {
CallExpression(node) {
const {
callee,
parent
} = node;

const {
parent: grandparent
} = (parent || {});
const {callee} = node;

if (callee.type === 'MemberExpression' && getMethodName(callee) === 'appendChild') {
let fix = fixer => fixer.replaceText(callee.property, 'append');

if (parent && ignoredParentTypes.includes(parent.type)) {
fix = undefined;
}

if (grandparent && ignoredGrandparentTypes.includes(grandparent.type)) {
if (!isReturnValueUsed(node)) {
fisker marked this conversation as resolved.
Show resolved Hide resolved
fix = undefined;
}

Expand Down
9 changes: 8 additions & 1 deletion rules/prefer-node-remove.js
View file
Open in desktop
@@ -1,5 +1,6 @@
'use strict';
const getDocumentationUrl = require('./utils/get-documentation-url');
const isReturnValueUsed = require('./utils/is-return-value-used');

const getMethodName = callee => {
const {property} = callee;
Expand Down Expand Up @@ -64,11 +65,17 @@ const create = context => {
)) {
const argumentName = getArgumentName(node.arguments);

let fix = fixer => fixer.replaceText(node, `${argumentName}.remove()`);

if (!isReturnValueUsed(node)) {
fix = undefined;
}

if (argumentName) {
context.report({
node,
message: `Prefer \`${argumentName}.remove()\` over \`${callerName}.removeChild(${argumentName})\`.`,
fix: fixer => fixer.replaceText(node, `${argumentName}.remove()`)
fix
});
}
}
Expand Down
24 changes: 24 additions & 0 deletions rules/utils/is-return-value-used.js
View file
Open in desktop
@@ -0,0 +1,24 @@
'use strict';

const ignoredParentTypes = [
'ArrayExpression',
'IfStatement',
'MemberExpression',
'Property',
'ReturnStatement',
'VariableDeclarator'
];

const ignoredGrandparentTypes = [
'ExpressionStatement'
];

module.exports = function (node) {
const {parent} = node;
const {
parent: grandparent
} = (parent || {});

return (!parent || !ignoredParentTypes.includes(parent.type)) &&
(!grandparent || !ignoredGrandparentTypes.includes(grandparent.type));
};
2 changes: 1 addition & 1 deletion test/integration/eslint-config-unicorn-tester/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

84 changes: 84 additions & 0 deletions test/prefer-node-remove.js
View file
Open in desktop
Expand Up @@ -90,6 +90,90 @@ ruleTester.run('prefer-node-remove', rule, {
'foo.remove()',
'parentElement',
'foo'
),
invalidTestCase(
'if (foo.parentNode.removeChild(foo)) {}',
'if (foo.parentNode.removeChild(foo)) {}',
'parentNode',
'foo'
),
invalidTestCase(
'var removed = foo.parentNode.removeChild(foo);',
'var removed = foo.parentNode.removeChild(foo);',
'parentNode',
'foo'
),
invalidTestCase(
'const foo = node.parentNode.removeChild(child);',
'const foo = node.parentNode.removeChild(child);',
'parentNode',
'child'
),
invalidTestCase(
'console.log(node.parentNode.removeChild(child));',
'console.log(node.parentNode.removeChild(child));',
'parentNode',
'child'
),
invalidTestCase(
'node.parentNode.removeChild(child) || "foo";',
'node.parentNode.removeChild(child) || "foo";',
'parentNode',
'child'
),
invalidTestCase(
'node.parentNode.removeChild(child) + 0;',
'node.parentNode.removeChild(child) + 0;',
'parentNode',
'child'
),
invalidTestCase(
'node.parentNode.removeChild(child) + 0;',
'node.parentNode.removeChild(child) + 0;',
'parentNode',
'child'
),
invalidTestCase(
'+node.parentNode.removeChild(child);',
'+node.parentNode.removeChild(child);',
'parentNode',
'child'
),
invalidTestCase(
'node.parentNode.removeChild(child) ? "foo" : "bar";',
'node.parentNode.removeChild(child) ? "foo" : "bar";',
'parentNode',
'child'
),
invalidTestCase(
'if (node.parentNode.removeChild(child)) {}',
'if (node.parentNode.removeChild(child)) {}',
'parentNode',
'child'
),
invalidTestCase(
'const foo = [node.parentNode.removeChild(child)]',
'const foo = [node.parentNode.removeChild(child)]',
'parentNode',
'child'
),
invalidTestCase(
'const foo = { bar: node.parentNode.removeChild(child) }',
'const foo = { bar: node.parentNode.removeChild(child) }',
'parentNode',
'child'
),
invalidTestCase(
'function foo() { return node.parentNode.removeChild(child); }',
'function foo() { return node.parentNode.removeChild(child); }',
'parentNode',
'child'
),
invalidTestCase(
'const foo = () => { return node.parentNode.removeChild(child); }',
'const foo = () => { return node.parentNode.removeChild(child); }',
'parentNode',
'child'
)
]
});