Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 8fa2029

Browse filesBrowse files
TrottMyles Borins
authored andcommitted
tools: lint rule for assert.fail()
`assert.fail()` is often mistakenly used with a single argument even in Node.js core. (See fixes to previous instances in b7f4b1b, 28e9a02. and 676e618.) This commit adds a linting rule to identify instances of this issue. PR-URL: #6261 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Minwoo Jung <jmwsoft@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
1 parent 6ad8591 commit 8fa2029
Copy full SHA for 8fa2029

File tree

Expand file treeCollapse file tree

2 files changed

+31
-0
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

2 files changed

+31
-0
lines changed
Open diff view settings
Collapse file

‎.eslintrc‎

Copy file name to clipboardExpand all lines: .eslintrc
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ rules:
8585
prefer-const: 2
8686

8787
# Custom rules in tools/eslint-rules
88+
assert-fail-single-argument: 2
8889
new-with-error: [2, "Error", "RangeError", "TypeError", "SyntaxError", "ReferenceError"]
8990

9091

Collapse file
+30Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
/**
2+
* @fileoverview Prohibit use of a single argument only in `assert.fail()`. It
3+
* is almost always an error.
4+
* @author Rich Trott
5+
*/
6+
'use strict';
7+
8+
//------------------------------------------------------------------------------
9+
// Rule Definition
10+
//------------------------------------------------------------------------------
11+
12+
const msg = 'assert.fail() message should be third argument';
13+
14+
function isAssert(node) {
15+
return node.callee.object && node.callee.object.name === 'assert';
16+
}
17+
18+
function isFail(node) {
19+
return node.callee.property && node.callee.property.name === 'fail';
20+
}
21+
22+
module.exports = function(context) {
23+
return {
24+
'CallExpression': function(node) {
25+
if (isAssert(node) && isFail(node) && node.arguments.length === 1) {
26+
context.report(node, msg);
27+
}
28+
}
29+
};
30+
};

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.