Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
5 changed files
with
199 additions
and
2 deletions.
There are no files selected for viewing
This file contains 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,26 @@ | ||
# Prefer `remove` over `parentNode.removeChild` and `parentElement.removeChild` | ||
|
||
Enforces the use of, for example, `child.remove();` over `child.parentNode.removeChild(child);` and `child.parentElement.removeChild(child);` for DOM nodes. The DOM function [`.remove()`](https://developer.mozilla.org/en-US/docs/Web/API/ChildNode/remove) is preferred over the indirect removal of an object with [`.removeChild()`](https://developer.mozilla.org/en-US/docs/Web/API/Node/removeChild). | ||
|
||
This rule is fixable. | ||
|
||
|
||
## Fail | ||
|
||
```js | ||
foo.parentNode.removeChild(foo); | ||
foo.parentElement.removeChild(foo); | ||
this.parentNode.removeChild(this); | ||
this.parentElement.removeChild(this); | ||
foo.parentNode.removeChild(bar); | ||
foo.parentElement.removeChild(bar); | ||
this.parentNode.removeChild(foo); | ||
this.parentElement.removeChild(foo); | ||
``` | ||
|
||
## Pass | ||
|
||
```js | ||
foo.remove(); | ||
this.remove(); | ||
``` |
This file contains 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 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 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,87 @@ | ||
'use strict'; | ||
const getDocsUrl = require('./utils/get-docs-url'); | ||
|
||
const getMethodName = callee => { | ||
const {property} = callee; | ||
|
||
if (property.type === 'Identifier') { | ||
return property.name; | ||
} | ||
|
||
return null; | ||
}; | ||
|
||
const getCallerName = callee => { | ||
const {object} = callee; | ||
|
||
if (object.type === 'Identifier') { | ||
return object.name; | ||
} | ||
|
||
if (object.type === 'MemberExpression') { | ||
const {property} = object; | ||
|
||
if (property.type === 'Identifier') { | ||
return property.name; | ||
} | ||
} | ||
|
||
return null; | ||
}; | ||
|
||
const getArgumentName = args => { | ||
const [identifier] = args; | ||
|
||
if (identifier.type === 'ThisExpression') { | ||
return 'this'; | ||
} | ||
|
||
if (identifier.type === 'Identifier') { | ||
return identifier.name; | ||
} | ||
|
||
return null; | ||
}; | ||
|
||
const create = context => { | ||
return { | ||
CallExpression(node) { | ||
const {callee} = node; | ||
|
||
if (node.arguments.length === 0 || | ||
callee.type !== 'MemberExpression' || | ||
callee.computed | ||
) { | ||
return; | ||
} | ||
|
||
const methodName = getMethodName(callee); | ||
const callerName = getCallerName(callee); | ||
|
||
if (methodName === 'removeChild' && ( | ||
callerName === 'parentNode' || | ||
callerName === 'parentElement' | ||
)) { | ||
const argumentName = getArgumentName(node.arguments); | ||
|
||
if (argumentName) { | ||
context.report({ | ||
node, | ||
message: `Prefer \`remove\` over \`${callerName}.removeChild\``, | ||
fix: fixer => fixer.replaceText(node, `${argumentName}.remove()`) | ||
}); | ||
} | ||
} | ||
} | ||
}; | ||
}; | ||
|
||
module.exports = { | ||
create, | ||
meta: { | ||
docs: { | ||
url: getDocsUrl(__filename) | ||
}, | ||
fixable: 'code' | ||
} | ||
}; |
This file contains 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,81 @@ | ||
import test from 'ava'; | ||
import avaRuleTester from 'eslint-ava-rule-tester'; | ||
import rule from '../rules/prefer-node-remove'; | ||
|
||
const ruleTester = avaRuleTester(test, { | ||
env: { | ||
es6: true | ||
} | ||
}); | ||
|
||
const invalidTestCase = (code, output, parentType) => { | ||
return { | ||
code, | ||
output, | ||
errors: [{message: `Prefer \`remove\` over \`${parentType}.removeChild\``}] | ||
}; | ||
}; | ||
|
||
ruleTester.run('prefer-node-remove', rule, { | ||
valid: [ | ||
'foo.remove()', | ||
'this.remove()', | ||
'remove()', | ||
'foo.parentNode.removeChild(\'bar\')', | ||
'foo.parentNode[\'bar\'](foo)', | ||
'foo.parentNode[removeChild](foo)', | ||
'foo.parentNode.removeChild()' | ||
], | ||
invalid: [ | ||
invalidTestCase( | ||
'foo.parentNode.removeChild(foo)', | ||
'foo.remove()', | ||
'parentNode' | ||
), | ||
invalidTestCase( | ||
'this.parentNode.removeChild(this)', | ||
'this.remove()', | ||
'parentNode' | ||
), | ||
invalidTestCase( | ||
'parentNode.removeChild(this)', | ||
'this.remove()', | ||
'parentNode' | ||
), | ||
invalidTestCase( | ||
'foo.parentNode.removeChild(bar)', | ||
'bar.remove()', | ||
'parentNode' | ||
), | ||
invalidTestCase( | ||
'this.parentNode.removeChild(foo)', | ||
'foo.remove()', | ||
'parentNode' | ||
), | ||
invalidTestCase( | ||
'foo.parentElement.removeChild(foo)', | ||
'foo.remove()', | ||
'parentElement' | ||
), | ||
invalidTestCase( | ||
'this.parentElement.removeChild(this)', | ||
'this.remove()', | ||
'parentElement' | ||
), | ||
invalidTestCase( | ||
'parentElement.removeChild(this)', | ||
'this.remove()', | ||
'parentElement' | ||
), | ||
invalidTestCase( | ||
'foo.parentElement.removeChild(bar)', | ||
'bar.remove()', | ||
'parentElement' | ||
), | ||
invalidTestCase( | ||
'this.parentElement.removeChild(foo)', | ||
'foo.remove()', | ||
'parentElement' | ||
) | ||
] | ||
}); |