Skip to content
Permalink
Browse files

tools: enforce deepStrictEqual over deepEqual

Introduce a lint rule that enforces use of `assert.deepStrictEqual()`
over `assert.deepEqual()`.

PR-URL: #6213
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
  • Loading branch information...
Trott committed Apr 19, 2016
1 parent a7335bd commit e84c69310f742c1b2381fa19b155db6f178af7da
Showing with 34 additions and 1 deletion.
  1. +2 −1 .eslintrc
  2. +32 −0 tools/eslint-rules/no-deepEqual.js
@@ -85,9 +85,10 @@ rules:
prefer-const: 2

# Custom rules in tools/eslint-rules
align-multiline-assignment: 2
assert-fail-single-argument: 2
new-with-error: [2, "Error", "RangeError", "TypeError", "SyntaxError", "ReferenceError"]
align-multiline-assignment: 2
no-deepEqual: 2

# Global scoped method and vars
globals:
@@ -0,0 +1,32 @@
/**
* @fileoverview Prohibit use of assert.deepEqual()
* @author Rich Trott
*
* This rule is imperfect, but will find the most common forms of
* assert.deepEqual() usage.
*/
'use strict';

//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------

const msg = 'assert.deepEqual() disallowed. Use assert.deepStrictEqual()';

function isAssert(node) {
return node.callee.object && node.callee.object.name === 'assert';
}

function isDeepEqual(node) {
return node.callee.property && node.callee.property.name === 'deepEqual';
}

module.exports = function(context) {
return {
'CallExpression': function(node) {
if (isAssert(node) && isDeepEqual(node)) {
context.report(node, msg);
}
}
};
};

0 comments on commit e84c693

Please sign in to comment.
You can’t perform that action at this time.